Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Orders action (under Orders (Data API)).
Fill in the fields below, then reference the result from later steps as {{getOrders.response.data}}.
Request
Path parameters
organizationIdstringrequired
An identifier for the organization the request is being made by
Query parameters
sortBystring
Sort results by creation date or last modified date. The default is creation date.
One ofcreation_datelast_modified_dateDefault "creation_date"
sortOrderstring
Sort results in ascending or descending order. The default is descending.
One ofascdescDefault "desc"
statusstring
Filter results by status. Valid statuses are 'new', 'completed', and 'cancelled'. You can include up to two statuses as a comma-separated string.
exportStatusarray<any>
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.
externalStatusstring
Filter results by external status.
confirmationStatusstring
Filter results by confirmation status. Valid confirmation statuses are 'confirmed' and 'not_confirmed'.
One ofconfirmednot_confirmed
paymentStatusarray<any>
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.
shippingStatusarray<any>
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.
creationDateFromstring (date-time)
If passed, will return records where the `creationDate` is equal to or greater than the passed `date-only`.
creationDateTostring (date-time)
If passed, will return records where the `creationDate` is less than the passed `date-only`.
lastModifiedDateFromstring (date-time)
If passed, will return records where the `lastModifiedDate` is equal to or greater than the passed `date-only`.
lastModifiedDateTostring (date-time)
If passed, will return records where the `lastModifiedDate` is less than the passed `date-only`.
siteIdstringrequired
The identifier 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.
limitinteger (int32)
Maximum records to retrieve per request, not to exceed 200. Defaults to 100.
Default 100
offsetinteger (int32)
Used to retrieve the results based on a particular resource offset.
Default 0
Response
Returns 200 with an object. Read it in later steps with {{getOrders.response.data.<field>}}.
dataarray<object>
The orders data.
adjustedMerchandizeTotalTaxnumber (double)
The total tax on products in the order, including price adjustments, but not including service charges such as shipping.
adjustedShippingTotalTaxnumber (double)
The total tax on shipping charges in the order, including shipping price adjustments.
affiliatePartnerIdstring
The affiliate partner ID.
affiliatePartnerNamestring
The affiliate partner name.
billingAddressany
The billing address.
bonusDiscountLineItemsarray<object>5 fields
The bonus discount line items.
businessTypestring
The business type.
One ofb2cb2b
cancelCodestring
The cancellation code.
cancelDescriptionstring
The cancellation description.
channelTypestring
The sales channel.
One ofstorefrontcallcentermarketplacedssstorepinteresttwitterfacebookadssubscriptionsonlinereservationcustomerservicecenterinstagramcommercetiktoksnapchatgooglewhatsappyoutube
confirmationStatusstring
The order confirmation status.
One ofconfirmednot_confirmed
couponItemsarray<object>4 fields
The coupon items.
createdBystring
This value depends on how the order was created. If a shopper created the order, this value is Customer. If a job created the order, this value is System. Otherwise, this value is the name of the user who created the order.
creationDatestring (date-time)
The timestamp when the order was created.
customerLocalestring
The locale of the customer who created the order.
currencystring
A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
customerInfoobject5 fields
Document representing a guest or logged-in customer.
customerOrderReferencestring
The customer-specific reference information.
exportStatusstring
The order export status.
One ofexportednot_exportedreadyfailed
externalOrderNostring
The external order number associated with the order.
externalOrderStatusstring
The status from an external order associated with this order.
externalOrderTextstring
The text from an external order associated with this order.
giftCertificateItemsarray<object>13 fields
The gift certificate line items.
globalPartyIdstring
The Customer 360 Global Party ID associated with the shopper.
invoiceNostring
The invoice number.
lastModifiedstring (date-time)
The timestamp when the order was last modified.
merchandizeTotalTaxnumber (double)
The total tax on products in the order, not including price adjustments or service charges such as shipping.
orderNostringrequired
The order number
orderPriceAdjustmentsarray<object>18 fields
The order-level price adjustments.
orderTotalnumber (double)
The total price, including products, shipping and, tax.
paymentInstrumentsarray<object>6 fields
The payment instruments list.
paymentStatusstring
The order payment status.
One ofpaidpart_paidnot_paid
placeDatestring (date-time)
The timestamp when the order was placed.
productItemsarray<object>31 fields
The product items.
productSubTotalnumber (double)
The total price of all products including item-level adjustments, but not including order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.
productTotalnumber (double)
The total price of all products including adjustments, but not including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.
remoteHoststring
The IP of the host that placed this order. You can turn IP logging on or off for your site.
shipmentsarray<object>17 fields
The shipments.
shippingItemsarray<object>13 fields
The shipping items.
shippingStatusstring
The order shipping status.
One ofshippedpart_shippednot_shipped
json
{"data":[{"orderNo":"00000410","adjustedMerchandizeTotalTax":4.95,"adjustedShippingTotalTax":0.3,"affiliatePartnerId":"PARTNER_US_001","affiliatePartnerName":"PARTNER_US_001","billingAddress":null,"bonusDiscountLineItems":[{"bonusProducts":[{"productId":null,"productName":null}],"couponCode":"5ties","id":"91f4dd8bfa0653d58b7783b04f","maxBonusItems":0,"promotionId":"Buy1Get2"}],"businessType":"b2c","cancelCode":"canceled","cancelDescription":"Ordered by mistake.","channelType":"storefront","confirmationStatus":"confirmed"}]}
