j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Returns the details of orders that match the query filters. By default, calling this API with no filter returns the 100 most recently created orders. To return up to 200 orders, use the limit parameter. To return a page of results past the first page, use a resource offset. Note : The sum of the offset and limit parameters cannot be greater than 10000.
curl "https://{shortCode}.api.commercecloud.salesforce.com/checkout/orders/v1/organizations/{organizationId}/orders?siteId=SiteGenesis"Region-specific merchant identifier.
fd4gt8
An identifier for the organization the request is being made by.
f_ecom_zzxy_prd
Sort results by creation date or last modified date. The default is creation date.
- creation_date
- last_modified_date
Sort results in ascending or descending order. The default is descending.
- asc
- desc
Filter results by status. Valid statuses are 'new', 'completed', and 'cancelled'. You can include up to two statuses as a comma-separated string.
cancelled,completed
Filter results by export status. Valid export statuses are 'not_exported', 'exported', 'ready', and 'failed'. You can include up to three export statuses as a comma-separated string.
not_exported,ready,failed
Filter results by external status.
Filter results by confirmation status. Valid confirmation statuses are 'confirmed' and 'not_confirmed'.
- confirmed
- not_confirmed
confirmed
Filter results by payment status. Valid payment statuses are 'not_paid', 'part_paid', and 'paid'. You can include up to two payment statuses as a comma-separated string.
not_paid,part_paid
Filter results by shipping status. Valid shipping statuses are 'not_shipped', 'part_shipped', and 'shipped'. You can include up to two shipping statuses as a comma-separated string.
not_shipped,part_shipped
The identifer of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites
SiteGenesis
Used to retrieve the results based on a particular resource offset.
Maximum records to retrieve per request, not to exceed 200. Defaults to 100.
If passed, will return records where the creationDate is equal to or greater than the passed datetime.
If passed, will return records where the creationDate is less than the passed datetime.
If passed, will return records where the lastModifiedDate is equal to or greater than the passed datetime.
If passed, will return records where the lastModifiedDate is less than the passed datetime.
The operation was successful.
{
"data": [
{
"adjustedMerchandizeTotalTax": 4.95,
"adjustedShippingTotalTax": 0.3,
"billingAddress": {
"address1": "45 Main Rd.",
"city": "Burlington",
"countryCode": "US",
"firstName": "Max",
"fullName": "Max Mustermann",
"lastName": "Mustermann",
"phone": "6175555555",
"postalCode": "05408",
"stateCode": "MA"
},
"confirmationStatus": "confirmed",
"createdBy": "storefront",
"creationDate": "2015-05-19T15:23:18.000Z",
"currency": "USD",
"customerInfo": {
"customerId": "abMKqMaNYOBMnNdDNzyC5oNTi5",
"customerName": "Max Mustermann",
"customerNo": "0002352",
"email": "no-reply@salesforce.com",
"guest": true
},
"customerLocale": "en_US",
"exportStatus": "not_exported",
"invoiceNo": "00000001",
"lastModified": "2020-11-04T14:13:31.061Z",
"merchandizeTotalTax": 4.95,
"orderNo": "00000410",
"orderTotal": 110.24,
"paymentInstruments": [
{
"paymentCard": {
"cardType": "Visa",
"creditCardExpired": true,
"expirationMonth": 1,
"expirationYear": 2020,
"holder": "Max Mustermann",
"maskedNumber": "***************1111",
"numberLastDigits": "1111",
"validFromMonth": 1,
"validFromYear": 2018
},
"paymentInstrumentId": "21052ad719a076cdc83637851e",
"paymentMethodId": "CREDIT_CARD",
"paymentTransaction": {
"amount": 110.24,
"transactionId": "40f07907428e23c4bbc6fb0446",
"c_authResult": "AUTHORIZED"
},
"c_issuerBank": "JPMORGAN CHASE BANK, N.A."
}
],
"paymentStatus": "not_paid",
"placeDate": "2015-05-19T15:23:18.000Z",
"productItems": [
{
"adjustedTax": 4.95,
"basePrice": 99,
"bonusProductLineItem": false,
"gift": false,
"grossPrice": 103.95,
"itemId": "99e96c7f8b46b98de2bae5d778",
"itemText": "Flat Front Pant",
"netPrice": 99,
"position": 1,
"priceAfterItemDiscount": 99,
"priceAfterOrderDiscount": 99,
"productId": "701643632930",
"productName": "Flat Front Pant",
"quantity": 1,
"shipmentId": "me",
"tax": 4.95,
"taxBasis": 99,
"taxRate": 0.05
}
],
"productSubTotal": 99,
"productTotal": 99,
"remoteHost": "127.0.0.1",
"shipments": [
{
"adjustedMerchandizeTotalTax": 4.95,
"adjustedShippingTotalTax": 0.3,
"gift": false,
"merchandizeTotalTax": 99,
"productSubTotal": 99,
"productTotal": 99,
"shipmentId": "me",
"shipmentNo": "00000001",
"shipmentTotal": 110.24,
"shippingAddress": {
"address1": "45 Main Rd.",
"city": "Burlington",
"countryCode": "US",
"firstName": "Max",
"fullName": "Max Mustermann",
"lastName": "Mustermann",
"phone": "6175555555",
"postalCode": "05408",
"stateCode": "MA"
},
"shippingMethod": {
"id": "DefaultShippingMethod"
},
"shippingStatus": "not_shipped",
"shippingTotal": 5.99,
"shippingTotalTax": 0.3,
"taxTotal": 5.25
}
],
"shippingItems": [
{
"adjustedTax": 0.3,
"basePrice": 5.99,
"grossPrice": 6.29,
"itemId": "23ace383d9355c881f1c00417a",
"itemText": "Shipping",
"netPrice": 5.99,
"priceAfterItemDiscount": 5.99,
"shipmentId": "me",
"tax": 0.3,
"taxBasis": 5.99,
"taxRate": 0.05,
"type": "fixed_price"
}
],
"shippingStatus": "not_shipped",
"shippingTotal": 5.99,
"shippingTotalTax": 0.3,
"siteId": "ShoppingSite",
"status": "new",
"taxation": "net",
"taxTotal": 5.25
}
]
}
The starting offset returned.
The limit requested.
The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
The number of results included in the response.
The orders data.
[{
"adjustedMerchandizeTotalTax": 4.95,
"adjustedShippingTotalTax": 1.3,
"billingAddress": {
"address1": "45 Main Rd.",
"city": "Burlington",
"countryCode": "US",
"firstName": "Max",
"fullName": "Max Mustermann",
"lastName": "Mustermann",
"phone": "6175555555",
"postalCode": "05408",
"stateCode": "MA"
},
"confirmationStatus": "confirmed",
"createdBy": "storefront",
"creationDate": "2015-05-19T15:23:18.000Z",
"currency": "USD",
"customerInfo": {
"customerId": "cdrjZ5iQeOQjpqKldaSzbvg2E8",
"customerName": "Max Mustermann",
"customerNo": "0002352",
"email": "no-reply@salesforce.com",
"guest": true
},
"customerLocale": "en_US",
"exportStatus": "not_exported",
"invoiceNo": "00000001",
"lastModified": "2020-11-05T13:08:05.588Z",
"merchandizeTotalTax": 4.95,
"orderNo": "00000410",
"orderTotal": 110.24,
"paymentInstruments": [
{
"paymentCard": {
"cardType": "Visa",
"creditCardExpired": true,
"expirationMonth": 1,
"expirationYear": 2020,
"holder": "Max Mustermann",
"maskedNumber": "***************1111",
"numberLastDigits": "1111",
"validFromMonth": 1,
"validFromYear": 2018
},
"paymentInstrumentId": "2c36f04e453a2512fba74ae1ea",
"paymentMethodId": "CREDIT_CARD",
"paymentTransaction": {
"amount": 110.24,
"transactionId": "40f07907428e23c4bbc6fb0446",
"c_authResult": "AUTHORIZED"
},
"c_issuerBank": "JPMORGAN CHASE BANK, N.A."
}
],
"paymentStatus": "not_paid",
"placeDate": "2015-05-19T15:23:18.000Z",
"productItems": [
{
"adjustedTax": 4.95,
"basePrice": 99,
"bonusProductLineItem": false,
"gift": false,
"grossPrice": 103.95,
"itemId": "3390171e44271bad9c36592049",
"itemText": "Flat Front Pant",
"netPrice": 99,
"position": 1,
"priceAfterItemDiscount": 99,
"priceAfterOrderDiscount": 99,
"productId": "701643632930",
"productName": "Flat Front Pant",
"quantity": 1,
"shipmentId": "me",
"shippingItemId": "a46294cffd6945a511cb6fce05",
"tax": 4.95,
"taxBasis": 99,
"taxRate": 0.05
}
],
"productSubTotal": 99,
"productTotal": 99,
"remoteHost": "127.0.0.1",
"shipments": [
{
"adjustedMerchandizeTotalTax": 4.95,
"adjustedShippingTotalTax": 1.3,
"gift": false,
"merchandizeTotalTax": 99,
"productSubTotal": 99,
"productTotal": 99,
"shipmentId": "me",
"shipmentNo": "00000001",
"shipmentTotal": 110.24,
"shippingAddress": {
"address1": "45 Main Rd.",
"city": "Burlington",
"countryCode": "US",
"firstName": "Max",
"fullName": "Max Mustermann",
"lastName": "Mustermann",
"phone": "6175555555",
"postalCode": "05408",
"stateCode": "MA"
},
"shippingMethod": {
"id": "DefaultShippingMethod"
},
"shippingStatus": "not_shipped",
"shippingTotal": 25.99,
"shippingTotalTax": 1.3,
"taxTotal": 5.25
}
],
"shippingItems": [
{
"adjustedTax": 0.3,
"basePrice": 5.99,
"grossPrice": 6.29,
"itemId": "4c3d46056d49226904ee61946c",
"itemText": "Shipping",
"netPrice": 5.99,
"priceAfterItemDiscount": 5.99,
"shipmentId": "me",
"tax": 0.3,
"taxBasis": 5.99,
"taxRate": 0.05,
"type": "fixed_price"
},
{
"adjustedTax": 1,
"basePrice": 10,
"grossPrice": 21,
"itemId": "a46294cffd6945a511cb6fce05",
"itemText": "Item Shipping Cost (Surcharge)",
"netPrice": 20,
"priceAfterItemDiscount": 20,
"shipmentId": "me",
"tax": 1,
"taxBasis": 20,
"taxRate": 0.05,
"type": "surcharge"
}
],
"shippingStatus": "not_shipped",
"shippingTotal": 25.99,
"shippingTotalTax": 1.3,
"siteId": "ShoppingSite",
"status": "new",
"taxation": "net",
"taxTotal": 5.25
}]