younifyd
Menu

Get Customer Orders

Get Customer Orders

GET/organizations/{organizationId}/customers/{customerId}/orders

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Get Customer Orders action (under Shopper Customers).
  3. Fill in the fields below, then reference the result from later steps as {{getCustomerOrders.response.data}}.

Request

Path parameters

customerIdstringrequired

The customer ID.

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Query parameters

crossSitesboolean

The flag indicating whether all sites should be searched. This flag is ignored unless a valid User / Agent is present with a trusted agent on behalf (TAOB) token. Without a TAOB token, only the customer's orders placed on the site specified by siteId are returned.

fromstring
untilstring
statusstring
expandstring

This parameter enhances the order result with extra data. By using `expand=som`, all orders for the current customer are loaded directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.

One ofoms

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)

Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.

Default 10

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 {{getCustomerOrders.response.data.<field>}}.

dataarray<object>

The array of customer order documents.

adjustedMerchandizeTotalTaxnumber (double)

The total tax on products in the order, including price adjustments, but not including service charges such as shipping. It is read only.

adjustedShippingTotalTaxnumber (double)

The total tax on shipping charges in the order, including shipping price adjustments. It is read only.

billingAddressany

The billing address.

bonusDiscountLineItemsarray<object>5 fields

The bonus discount line items.

channelTypestring

The sales channel. It is read only.

One ofstorefrontcallcentermarketplacedssstorepinteresttwitterfacebookadssubscriptionsonlinereservationcustomerservicecenterinstagramcommercetiktoksnapchatgooglewhatsappyoutube

confirmationStatusstring

The confirmation status.

One ofnot_confirmedconfirmed

couponItemsarray<object>4 fields

The coupon items. It is read only.

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. It is read only.

creationDatestring (date-time)

The timestamp when the order was created. It is read only.

currencyany

The ISO 4217 mnemonic code of the currency. It is read only.

customerInfoany

The customer information for guest or logged-in customers. It is read only.

customerNamestring

The customer name. It is read only.

exportStatusstring

The export status of the order.

One ofnot_exportedexportedreadyfailed

externalOrderStatusstring

The external status of the order.

giftCertificateItemsarray<object>7 fields

The gift certificate line items. It is read only.

globalPartyIdstring

The Customer 360 Global Party ID associated with the shopper. It is read only.

lastModifiedstring (date-time)

The timestamp when the order was last modified. It is read only.

merchandizeTotalTaxnumber (double)

The total products tax in the purchase currency. Merchandise total prices represent the sum of product prices not including shipping or adjustments. It is read only.

orderNoany

The order number.

orderPriceAdjustmentsarray<object>12 fields

The order-level price adjustments. It is read only.

orderTokenstring

The order token used to secure the lookup of an order on base of the plain order number. The order token contains only URL safe characters. It is read only.

orderTotalnumber (double)

The total price, including products, shipping, and tax. It is read only.

orderViewCodestring

The order view code used to secure the order lookup of an order using Order Lookup API. The order view code contains only URL safe characters. Warning : Order view code must not be exposed in the URL and must only be displayed to the shopper or sent as an email. Order view code must not be logged in the code. It is read only.

paymentInstrumentsarray<object>9 fields

The payment instruments list.

paymentStatusstring

The payment status.

One ofnot_paidpart_paidpaid

productItemsarray<object>1 fields

The product items. It is read only.

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. It is read only.

productTotalnumber (double)

The total price of all products in the shipment including item-level adjustments and prorated order-level 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. It is read only.

taxRoundedAtGroupboolean

If the tax is rounded at the group level, this is set to true. If the tax is rounded at the item or unit level, it is set to false. It is read only.

shipmentsarray<object>17 fields

The shipments. It is read only.

shippingItemsarray<object>12 fields

The shipping items. It is read only.

shippingStatusstring

The shipping status.

One ofnot_shippedpart_shippedshipped

shippingTotalnumber (double)

The total price of all shipping charges, including shipping adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.

shippingTotalTaxnumber (double)

The total tax on all shipping charges, not including shipping adjustments. It is read only.

siteIdany

The order's site. It is read only.

omsDataany

Information retrieved from Order Management (OMS) for the order.

sourceCodestring

The source code assigned to the basket from which this order was created. It is read only.

statusstring

The status.

One ofcreatednewcompletedcancelledreplacedfailed

taxTotalnumber (double)

The total tax amount. It is read only.

taxationstring

The taxation policy (gross or net). It is read only.

One ofgrossnet

json
{
  "data": [
    {
      "adjustedMerchandizeTotalTax": 1.5,
      "adjustedShippingTotalTax": 0.3,
      "billingAddress": null,
      "bonusDiscountLineItems": [
        {
          "bonusProducts": [
            {
              "productId": null,
              "productDescription": null,
              "productName": null,
              "title": null
            }
          ],
          "couponCode": "5ties",
          "id": "91f4dd8bfa0653d58b7783b04f",
          "maxBonusItems": 0,
          "promotionId": "Buy1Get2"
        }
      ],
      "channelType": "storefront",
      "confirmationStatus": "confirmed",
      "couponItems": [
        {
          "code": "5ties",
          "couponItemId": null,
          "statusCode": "no_applicable_promotion",
          "valid": true
        }
      ],
      "createdBy": "Customer",
      "creationDate": "2015-05-19T15:23:18.000Z",
      "currency": null,
      "customerInfo": null,
      "customerName": "Max Mustermann"
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.