Sign in

v1

latestOpenAPI 3.0.02026-07-141525155.4 KB
External Seller

Send invoice

This request is sent by the external seller to the VTEX marketplace to send invoice information.

This can be necessary in a regular order or in the case of a return. The type field is used to indicate which of these is the case.

post/{marketplaceServicesEndpoint}/pvt/orders/{marketplaceOrderId}/invoice

Path parameters

marketplaceServicesEndpointstring required
Example:marketplaceservicesendpoint.myvtex.com

This is an endpoint sent from VTEX to the external seller in the Order placement request.

marketplaceOrderIdstring required
Example:1138342255777-01

Identifies the order in the marketplace.

Headers

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required
Example:application/json

Describes the type of the content being sent.

Request body

courierstring

Courier, if available on invoice.

invoiceNumberstring required

Invoice number

invoiceValueinteger

Invoice value.

issuanceDatestring

Issuance date.

trackingNumberstring

Tracking number.

trackingUrlstring

Tracking URL.

typestring required

Indicates the type of the invoice. Use "Output" for regular orders and "Input" for returns.

Example request

{
  "courier": "courier-example",
  "invoiceNumber": "NFe-00002",
  "invoiceValue": 6000,
  "issuanceDate": "2021-05-21T10:00:00",
  "items": [
    {
      "id": "6",
      "price": 5500,
      "quantity": 1
    }
  ],
  "trackingNumber": "12345678abc",
  "trackingUrl": "https://courier-example.com/tracking",
  "type": "Output"
}

Response

OK