Update an order based on the order Id
put
https://api.mercadoe.com/v1/orders/{orderId}
Change fields of a specific purchase order with provided values.
Request
Headers
X-ME-CORRELATION-ID
string
Internal client code to be identified in the webhook. It can be, for example, a product code in your ERP, an order number, etc.
Path Parameters
orderId
int32
required
the order id
Body
application/json
identifier
string
Purchase document identifier.
documentType
string | null
Purchase document type code.
documentTypeDescription
string | null
Purchase document type description.
integrationTag
string | null
Identification of the ME user used in the integration.
isCanceled
boolean
Is this order canceled? (True/False)
- Canceled order = “True”.
- Active order = “False”.
- Canceled order = “True”.
- Active order = “False”.
clientPaymentConditionId
string | null
Payment Condition code
currency
string | null
Currency in alphabetic code (for more information, please refer to: https://www.iso.org/iso-4217-currency-codes.html).
incoTerms
string | null
Freight code (Incoterms)
note
string | null
Header Note
supplierAccountNumber
string | null
Supplier account number
purchasingGroup
string | null
Purchasing Group
email
string | null
Email
clientDeliveryPlaceId
int32 | null
Header delivery location code
clientInvoicingPlaceId
int32 | null
Header invoicing location code
clientBillingPlaceId
int32 | null
Header billing location code
businessOrganizations
array of object
required
Business Organizations is a list consisting of the Company Code and the Delivery Center/Location Code.
items
array of object
required
List with items information
attributes
array of object
Attributes of the order, consisting of a name and a value.
Responses
204
400
404
No Content