Get all pre-orders by query parameters
get
https://api.mercadoe.com/v1/pre-orders
Returns a list of all purchase pre-orders available to the connected user, filtered according to the specified query parameters.
Request
Query Parameters
clientPreOrderId
string
the pre order id in the client's ERP
pageNumber
int32
the page number must be an integer greater than or equal to 1
default:
1pageSize
int32
the page size must be an integer greater than or equal to 1
default:
10Responses
200
404
OK
Body
application/json
preOrderId
int32
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.
- 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 MEG (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 (Work Breakdown Structure element, in Portuguese is called “Elemento PEP”) is a structured component within a project, used to organize and manage project work in a hierarchical manner.)
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.
orderResponsibleName
string | null
Name of the person responsible for the order. For example, a requester or a buyer.
contractId
int32 | null
Contract Id.
clientContractId
string | null
Contract Code in customer’s ERP.