Process order by lookup key
GET/orders/:lookupKey/:lookupValue/process
Process an order by a specific lookupKey / lookupId combination.
lookupKeys |
---|
id |
externalId |
Processing an order does the following:
- for each supplier in the order a purchase order and backorder is created
- the order is set to status CONFIRMED
Once an order is processed, shipments / track and trace codes can be booked on backorders.
Request
Path Parameters
Use id
or externalId
id
- Integer
The id
or externalId
of the order
id
- Integer, externalId
- String
Responses
- 200
- 404
Process order by lookup key - 200
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Process order by lookup key - 200
Schema
data
object
clientData
object
invoiceData
object
address
object
paymentData
object
postageData
object
shippingData
object
address
object
total
object
tax
object
{
"data": {
"clientData": {
"abbreviation": "JS",
"company": "Propellor",
"dateOfBirth": "",
"debtorId": "753953",
"email": "julielarue@propellor.eu",
"firstName": "Jullien",
"fullName": "Jullien Serres",
"gender": "M",
"id": 14718,
"lastName": "Serres",
"login": "julielarue@propellor.eu",
"middleName": "",
"mobile": "06-12345678",
"phone": "020-6717171",
"ssn": "",
"title": "",
"vatNumber": ""
},
"date": "2022-03-16T15:00:55",
"debtorId": "753953",
"email": "",
"externalId": "",
"extraInfo": "",
"firstName": "Julien",
"id": 195,
"invoiceData": {
"address": {
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "w.spies@propel.us",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81902,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "",
"numberExtension": "",
"phone": "+31206717171",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat 20",
"type": "invoice",
"url": ""
}
},
"itemCount": 1,
"language": "EN-US",
"lastName": "Serres",
"middleName": "",
"paymentData": {
"grossAmount": 0,
"netAmount": 0,
"payMethod": "",
"payStatus": "",
"paystatusdate": "",
"tax": 0,
"taxPercentage": 21,
"transactionId": ""
},
"postageData": {
"carrier": "",
"partialDeliveryAllowed": "Y",
"postage": 0,
"postageNet": 0,
"postageTaxPercentage": 21,
"requestDate": "",
"shippingMethod": ""
},
"reference": "",
"remarks": "",
"shippingData": {
"address": {
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81903,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "20",
"numberExtension": "",
"phone": "",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat",
"type": "delivery",
"url": ""
}
},
"shopId": 1,
"siteId": 100037,
"source": "intern",
"status": "CONFIRMED",
"total": {
"discountPercentage": 0,
"discountValue": 0,
"tax": {
"11": 32.2234,
"21": 0
},
"totalGross": 292.94,
"totalNet": 325.1634
},
"type": "dropshipment",
"userId": 14718
},
"messages": [
"Order processed"
],
"total": 1
}
{
"data": {
"clientData": {
"abbreviation": "JS",
"company": "Propellor",
"dateOfBirth": "",
"debtorId": "753953",
"email": "julielarue@propellor.eu",
"firstName": "Jullien",
"fullName": "Jullien Serres",
"gender": "M",
"id": 14718,
"lastName": "Serres",
"login": "julielarue@propellor.eu",
"middleName": "",
"mobile": "06-12345678",
"phone": "020-6717171",
"ssn": "",
"title": "",
"vatNumber": ""
},
"date": "2022-03-16T15:00:55",
"debtorId": "753953",
"email": "",
"externalId": "",
"extraInfo": "",
"firstName": "Julien",
"id": 195,
"invoiceData": {
"address": {
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "w.spies@propel.us",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81902,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "",
"numberExtension": "",
"phone": "+31206717171",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat 20",
"type": "invoice",
"url": ""
}
},
"itemCount": 1,
"language": "EN-US",
"lastName": "Serres",
"middleName": "",
"paymentData": {
"grossAmount": 0,
"netAmount": 0,
"payMethod": "",
"payStatus": "",
"paystatusdate": "",
"tax": 0,
"taxPercentage": 21,
"transactionId": ""
},
"postageData": {
"carrier": "",
"partialDeliveryAllowed": "Y",
"postage": 0,
"postageNet": 0,
"postageTaxPercentage": 21,
"requestDate": "",
"shippingMethod": ""
},
"reference": "",
"remarks": "",
"shippingData": {
"address": {
"active": "Y",
"city": "Apeldoorn",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Julien",
"gender": "U",
"icp": "N",
"id": 81903,
"isDefault": "N",
"lastName": "Serres",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "20",
"numberExtension": "",
"phone": "",
"postalCode": "7323 KE",
"region": "",
"street": "Mazurkastraat",
"type": "delivery",
"url": ""
}
},
"shopId": 1,
"siteId": 100037,
"source": "intern",
"status": "CONFIRMED",
"total": {
"discountPercentage": 0,
"discountValue": 0,
"tax": {
"11": 32.2234,
"21": 0
},
"totalGross": 292.94,
"totalNet": 325.1634
},
"type": "dropshipment",
"userId": 14718
},
"messages": [
"Order processed"
],
"total": 1
}
Order process by lookup key - 404
Response Headers
Alt-Svc
string
Via
string
alt-svc
string
content-length
string
date
string
return-format
string
server
string
x-request-id
string
- application/json
- Schema
- Example (from schema)
- Order process by lookup key - 404
Schema
error
object
{
"error": {
"code": 15001,
"messages": [
"Order with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15001",
"status": 404,
"type": "OrderNotFound"
}
}
{
"error": {
"code": 15001,
"messages": [
"Order with id [295] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15001",
"status": 404,
"type": "OrderNotFound"
}
}