Documentation
Feedback
Guides
API Reference

Guides
Orders
Actions in orders
Formatting order invoicing time via API

When submitting invoice data to a marketplace via API, you can use the endpoint Update order's partial invoice to format the order invoicing time. The correct JSON format for the request is as the following example:


_18
{
_18
"type":"Output",
_18
"issuanceDate":"2017-10-05T11:32:11",
_18
"invoiceNumber":"9999",
_18
"invoiceValue":"10000",
_18
"invoiceKey": null,
_18
"invoiceUrl": null,
_18
"courier": null,
_18
"trackingNumber": null,
_18
"trackingUrl": null,
_18
"items": [
_18
{
_18
"id": "1234",
_18
"price": 10000,
_18
"quantity": 1
_18
}
_18
]
_18
}

The property responsible for informing the invoicing date and time is issuanceDate. This field follows the UTC 0 time zone.

If you want to include a time with a specific time zone (for example: "UTC -3"), you must use a format like the example below:

"issuanceDate": "2017-10-05T11:32:11-0300"

Attention: Do not use any spaces on the date.

Note that integrations that fetch order data from the VTEX system should also be aware of the time zone and make the necessary adjustments.

For details on how the request should be formatted, see the API Update order's partial invoice.

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page