Create an order
post
https://api.mercadoe.com/v1/orders
Create a new purchase order by providing the payment condition, items, supplier, delivery place, and other details.
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.
Body
application/json
clientOrderId
string
Purchase document identifier.
clientSupplierId
string
required
Supplier code in the client’s ERP
clientPaymentConditionId
string | null
Client payment condition code
incoTerms
string | null
Freight code (Incoterms)
email
string | null
Buyer’s email
currency
string | null
Currency in alphabetic code (for more information, please refer to: https://www.iso.org/iso-4217-currency-codes.html).
note
string | null
Header note
integrationTag
string
required
Identification of the ME user used in the integration.
isCanceled
boolean | null
Is this order canceled? (True/False)
- Canceled order = “True”.
- Active order = “False”.
- Canceled order = “True”.
- Active order = “False”.
clientDeliveryPlaceId
string | null
Client delivery place id
clientInvoicingPlaceId
string | null
Client invoicing place id
summary
string | null
Order title
freightValue
double | null
Freight value
isVisibleToSupplier
boolean | null
Flag to indicate if the order is visible to the supplier.
items
array of object
List of order items.
businessOrganizations
array of object | null
Business Organizations is a list consisting of the Company Code and the Delivery Center/Location Code.
attributes
array of object | null
List with the attributes of the ordered items, consisting of the name, value and description fields.
Responses
202
400
Accepted
Body
application/json
correlationId
string