Order by lookup key
PATCH/orders/:lookupKey/:lookupValue
Update order headers details. This request does not support updating orderitems. An order address
can be updated using the order address endpoints.
Orders are referenced by a lookupKey / lookupId combination
lookupKeys |
---|
id |
sourceId |
Request
Path Parameters
Use id
or externalId
id
- Integer
The id
or externalId
of the order
- application/json
Body
Responses
- 200
- 400
- 404
Update Order - 200 / Update Order postage data - 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)
- Update Order - 200
- Update Order postage data - 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": "SV",
"company": "",
"dateOfBirth": "",
"debtorId": "",
"email": "sander123@propel.us",
"firstName": "Sander",
"fullName": "Sander Vleugelhof",
"gender": "U",
"id": 14711,
"lastName": "Vleugelhof",
"login": "sander123@propel.us",
"middleName": "",
"mobile": "undefined",
"phone": "020-6717171",
"ssn": "",
"title": "",
"vatNumber": ""
},
"date": "2022-02-24T14:14:55",
"debtorId": "",
"email": "",
"externalId": "50001",
"extraInfo": "",
"firstName": "Sander",
"id": 162,
"invoiceData": {
"address": {
"active": "Y",
"city": "Amsterdam",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Sander",
"gender": "U",
"icp": "N",
"id": 81752,
"isDefault": "N",
"lastName": "Vleugelhof",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "257",
"numberExtension": "",
"phone": "",
"postalCode": "1234 AB",
"region": "",
"street": "Gedempt Hamerkanaal",
"type": "invoice",
"url": ""
}
},
"itemCount": 1,
"language": "EN-US",
"lastName": "Vleugelhof",
"middleName": "",
"paymentData": {
"grossAmount": 0,
"netAmount": 0,
"payMethod": "",
"payStatus": "",
"paystatusdate": "",
"tax": 0,
"taxPercentage": 21,
"transactionId": ""
},
"postageData": {
"carrier": "",
"partialDeliveryAllowed": "Y",
"postage": 5,
"postageNet": 6.05,
"postageTaxPercentage": 21,
"requestDate": "",
"shippingMethod": ""
},
"reference": "",
"remarks": "",
"shippingData": {
"address": {
"active": "Y",
"city": "Amsterdam",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Sander",
"gender": "U",
"icp": "N",
"id": 81753,
"isDefault": "N",
"lastName": "Vleugelhof",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "257",
"numberExtension": "",
"phone": "",
"postalCode": "1234 AB",
"region": "",
"street": "Gedempt Hamerkanaal",
"type": "delivery",
"url": ""
}
},
"shopId": 1,
"siteId": 100037,
"source": "intern",
"status": "ARCHIVED",
"total": {
"discountPercentage": 0,
"discountValue": 0,
"tax": {
"21": 3.15
},
"totalGross": 20,
"totalNet": 24.2
},
"type": "dropshipment",
"userId": 14711
},
"messages": [
"Updated"
],
"total": 1
}
{
"data": {
"clientData": {
"abbreviation": "SV",
"company": "",
"dateOfBirth": "",
"debtorId": "",
"email": "sander123@propel.us",
"firstName": "Sander",
"fullName": "Sander Vleugelhof",
"gender": "U",
"id": 14711,
"lastName": "Vleugelhof",
"login": "sander123@propel.us",
"middleName": "",
"mobile": "undefined",
"phone": "020-6717171",
"ssn": "",
"title": "",
"vatNumber": ""
},
"date": "2022-02-24T14:14:55",
"debtorId": "",
"email": "",
"externalId": "50001",
"extraInfo": "",
"firstName": "Sander",
"id": 162,
"invoiceData": {
"address": {
"active": "Y",
"city": "Amsterdam",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Sander",
"gender": "U",
"icp": "N",
"id": 81752,
"isDefault": "N",
"lastName": "Vleugelhof",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "257",
"numberExtension": "",
"phone": "",
"postalCode": "1234 AB",
"region": "",
"street": "Gedempt Hamerkanaal",
"type": "invoice",
"url": ""
}
},
"itemCount": 1,
"language": "EN-US",
"lastName": "Vleugelhof",
"middleName": "",
"paymentData": {
"grossAmount": 0,
"netAmount": 0,
"payMethod": "",
"payStatus": "",
"paystatusdate": "",
"tax": 0,
"taxPercentage": 21,
"transactionId": ""
},
"postageData": {
"carrier": "",
"partialDeliveryAllowed": "Y",
"postage": 5,
"postageNet": 6.05,
"postageTaxPercentage": 21,
"requestDate": "",
"shippingMethod": ""
},
"reference": "",
"remarks": "",
"shippingData": {
"address": {
"active": "Y",
"city": "Amsterdam",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Sander",
"gender": "U",
"icp": "N",
"id": 81753,
"isDefault": "N",
"lastName": "Vleugelhof",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "257",
"numberExtension": "",
"phone": "",
"postalCode": "1234 AB",
"region": "",
"street": "Gedempt Hamerkanaal",
"type": "delivery",
"url": ""
}
},
"shopId": 1,
"siteId": 100037,
"source": "intern",
"status": "ARCHIVED",
"total": {
"discountPercentage": 0,
"discountValue": 0,
"tax": {
"21": 3.15
},
"totalGross": 20,
"totalNet": 24.2
},
"type": "dropshipment",
"userId": 14711
},
"messages": [
"Updated"
],
"total": 1
}
{
"data": {
"clientData": {
"abbreviation": "SV",
"company": "",
"dateOfBirth": "",
"debtorId": "",
"email": "sander123@propel.us",
"firstName": "Sander",
"fullName": "Sander Vleugelhof",
"gender": "U",
"id": 14711,
"lastName": "Vleugelhof",
"login": "sander123@propel.us",
"middleName": "",
"mobile": "undefined",
"phone": "020-6717171",
"ssn": "",
"title": "",
"vatNumber": ""
},
"date": "2022-02-24T14:14:55",
"debtorId": "",
"email": "",
"externalId": "50001",
"extraInfo": "",
"firstName": "Sander",
"id": 162,
"invoiceData": {
"address": {
"active": "Y",
"city": "Amsterdam",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Sander",
"gender": "U",
"icp": "N",
"id": 81752,
"isDefault": "N",
"lastName": "Vleugelhof",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "257",
"numberExtension": "",
"phone": "",
"postalCode": "1234 AB",
"region": "",
"street": "Gedempt Hamerkanaal",
"type": "invoice",
"url": ""
}
},
"itemCount": 1,
"language": "EN-US",
"lastName": "Vleugelhof",
"middleName": "",
"paymentData": {
"grossAmount": 0,
"netAmount": 0,
"payMethod": "",
"payStatus": "",
"paystatusdate": "",
"tax": 0,
"taxPercentage": 21,
"transactionId": ""
},
"postageData": {
"carrier": "",
"partialDeliveryAllowed": "Y",
"postage": 5,
"postageNet": 6.05,
"postageTaxPercentage": 21,
"requestDate": "",
"shippingMethod": ""
},
"reference": "",
"remarks": "",
"shippingData": {
"address": {
"active": "Y",
"city": "Amsterdam",
"code": "",
"company": "",
"country": "NL",
"email": "",
"fax": "",
"firstName": "Sander",
"gender": "U",
"icp": "N",
"id": 81753,
"isDefault": "N",
"lastName": "Vleugelhof",
"middleName": "",
"mobile": "",
"name": "",
"notes": "",
"number": "257",
"numberExtension": "",
"phone": "",
"postalCode": "1234 AB",
"region": "",
"street": "Gedempt Hamerkanaal",
"type": "delivery",
"url": ""
}
},
"shopId": 1,
"siteId": 100037,
"source": "intern",
"status": "ARCHIVED",
"total": {
"discountPercentage": 0,
"discountValue": 0,
"tax": {
"21": 3.15
},
"totalGross": 20,
"totalNet": 24.2
},
"type": "dropshipment",
"userId": 14711
},
"messages": [
"Updated"
],
"total": 1
}
Update Order - 400 (invalide fieldname)
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)
- Update Order - 400 (invalide fieldname)
Schema
error
object
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [Date] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
{
"error": {
"code": 10007,
"messages": [
"#: extraneous key [Date] is not permitted"
],
"moreInfo": "https://www.propel.us/docs/errors/10007",
"status": 400,
"type": "SchemaValidationException"
}
}
Update Order - 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)
- Update Order - 404
Schema
error
object
{
"error": {
"code": 15001,
"messages": [
"Order with id [1600] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15001",
"status": 404,
"type": "OrderNotFound"
}
}
{
"error": {
"code": 15001,
"messages": [
"Order with id [1600] not found"
],
"moreInfo": "https://www.propel.us/docs/errors/15001",
"status": 404,
"type": "OrderNotFound"
}
}