1. Strona główna
  2. Dokumentacja
  3. REST API xSale
  4. Przykłady wykorzystania R...
  5. Jak wysłać dokument FV do zamówienia przez API

Jak wysłać dokument FV do zamówienia przez API

Aby dodać fakturę do zamówienia w systemie xSale i przesłać ją do Amazon, należy użyć odpowiednich metod API opisanych poniżej.

Dodanie załącznika (dla opisywanego przykładu jest to faktura)

POST /{organizationName}/orders/{id}/attachments

Dodanie załącznika przez API

Parametry:

Parametr Opis
Id Identyfikator zamówienia w xSale
typeIds Lista typów załączników (np. dla faktury:2048 )
documentNumber Numer faktury – wyświetlany w interfejsie i przesyłany do Amazon
file Plik z treścią faktury

Lista dostępnych typów załączników

Aby pobrać listę typów załączników (w tym identyfikator typu faktura:2048), skorzystaj z metody:

GET /{organizationName}/orders/attachments-types

Wysyłka do Amazon

Załącznik zostanie wysłany do Amazon tylko jeśli:

  • typ załącznika to Faktura sprzedaży
  • podano numer dokumentu (documentNumber)

Aktualizacja załącznika

Jeśli faktura nie została jeszcze wysłana (np. brakowało numeru), można ją zaktualizować – wtedy zostanie wysłana. Faktury już wysłanej nie można ponownie wysłać po edycji. Metoda:

PUT /{organizationName}/orders/{id}/attachments/{attachmentId}

Usuwanie załącznika

Metoda:

DELETE /{organizationName}/orders/{id}/attachments/{attachmentId}

Jeżeli załącznik został już wysłany do Amazon – zostanie usunięty tylko w xSale (nie w Amazon).

Pobieranie listy załączników

Aby wyświetlić wszystkie załączniki dla zamówienia:

GET /{organizationName}/orders/{id}

Załączniki są również widoczne w interfejsie użytkownika xSale:

załączniki dostępne w interfejsie użytkownika xSale