Skip to content

Get a pre-order based on the Id

get
https://api.mercadoe.com/v1/pre-orders/{id}

Get information about a specific pre-order with the given Id.

Request

Path Parameters

id
int32
required
The pre-order id

Responses

200
404
OK

Body

application/json
preOrderId
int32 | null
Pre-Order Id.
category
string | null
Type of purchase order to be created in the ERP.
integrationTag
string | null
Identification of the ME user used in the integration.
status
int32 | null
Status code
clientOrderId
string | null
ERP Order Number:
- Filled = it identifies that you should modify an order.
- Empty = it identifies that you should create an order.
clientSupplierId
string | null
Supplier code in the ERP.
supplierId
int32 | null
Supplier ID.
clientPaymentConditionId
string | null
Payment condition code
currency
string | null
Currency ID (ISO 4217:2015)
icoTerms
string | null
Freight code (Incoterms)
freightValue
double | null
Freight value (Incoterms)
note
string | null
Pre-order header note
summary
string | null
Pre-order title
quotationId
int32 | null
Quotation Id
isInvisible
boolean | null
It indicates if the pre-order is invisible.
automation
boolean | null
Flag to indicate if this is an automation created by MAG (ME Automation Genius) - a RPA for Process Automation (Y/N).
creationDate
date-time | null
Pre-order creation date
clientDeliveryPlaceId
string | null
Header delivery place code.
clientInvoicingPlaceId
string | null
Header invoicing place code.
partnerSupplierId
int32 | null
Partner supplier.
grossValue
double | null
Gross value.
wbsElement
string | null
WBS element (A WBS element is a structural element of a specific enterprise project.)
clientExchangeRate
double | null
Value of the foreign currency exchange rate.
otherExpenses
double | null
Amount referring to other expenses
clientBillingPlaceId
string | null
Header billing place code.