Get an order based on the order Id.
get
https://api.mercadoe.com/v1/orders/{orderId}
Get information about a specific purchase order with the given orderId.
Request
Path Parameters
orderId
int32
required
the order id
Responses
200
404
OK
Body
application/json
orderId
int32
ID of the ME purchase order
clientOrderId
string | null
The order ID in the Client’s ERP
creationDate
date-time
Order creation date
dateAlteration
date-time | null
It is the date when the order was changed.
quotationId
int32 | null
Quotation Id
deliveryDate
date-time | null
Order delivery date
readingDate
date-time | null
Order reading date
preOrderId
int32 | null
Pre order Id
approvalDate
date-time | null
Order confirmation date
contractId
int32 | null
Contract Id
incoTerms
string | null
Freight code (IncoTerms)
languageId
int32 | null
Default language selection:
- 0 = Portuguese (BR)
- 1 = English
- 2 = Spanish
- 0 = Portuguese (BR)
- 1 = English
- 2 = Spanish
deliveryDeadline
int32 | null
Delivery deadline in days
invisible
boolean | null
It indicates if the order is invisible.
freightValue
double | null
Freight value
deliveryPlace
object
billingPlace
object
invoicingPlace
object
name
string | null
Buyer’s name
integrationTag
string | null
Identification of the ME user used in the integration
clientSupplierId
string | null
Supplier code in the client’s ERP
login
string | null
User login
phone
string | null
Buyer’s phone
email
string | null
Buyer’s email
contact
string | null
Buyer’s contact
summary
string | null
Order title
clientPaymentConditionId
string | null
Client 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).
note
string | null
Header note
companyName
string | null
Company name
status
string
allowed values:
RefusedCanceledConfirmedWaitingResponseUnreadParciallyConfirmedisCanceled
boolean | null
Is this order canceled? (True/False)
- Canceled order = “True”.
- Active order = “False”.
- Canceled order = “True”.
- Active order = “False”.
isChanged
boolean | null
Is this order changed? (True/False)
- Changed order = “True”.
- Not changed order = “False”.
- Changed order = “True”.
- Not changed order = “False”.
partnerSupplierId
int32 | null
Partner supplier id
clientExchangeRate
double | null
Value of the foreign currency exchange rate for the client.
documentNumber
string | null
deprecated
Document identification number
documentType
string | null
deprecated
Type of document used for national registration in the country.
Ex: CNPJ, IE, etc.
Ex: CNPJ, IE, etc.