younifyd
Menu

Get Order 2

Return order details for the specified order number.

GET/organizations/{organizationId}/orders/{orderNo}

Use it in a workflow

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

Request

Path parameters

orderNostringrequired

The order number.

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

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.

Response

Returns 200 with an object. Read it in later steps with {{getOrder2.response.data.<field>}}.

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>

The bonus discount line items.

bonusProductsarray<object>2 fields

The bonus products from which the customer can choose.

couponCodestring

The coupon code that triggered the promotion, if applicable.

idstring

The ID of the line item.

maxBonusItemsinteger (int32)

The maximum number of bonus items the user can select for this promotion.

promotionIdstring

The ID of the promotion that triggered the creation of the line item.

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>

The coupon items.

codestring

The coupon code.

couponItemIdstring

The coupon item ID.

statusCodestring

The status of the coupon item.

One ofcoupon_code_already_in_basketcoupon_code_already_redeemedcoupon_code_unknowncoupon_disabledredemption_limit_exceededcustomer_redemption_limit_exceededtimeframe_redemption_limit_exceededno_active_promotioncoupon_already_in_basketno_applicable_promotionappliedadhoc

validboolean

A flag indicating whether the coupon item is valid. A coupon line item is valid if the status code is "applied" or "no_applicable_promotion".

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.

customerInfoobject

Document representing a guest or logged-in customer.

customerIdstring

The customer ID.

customerNamestring

The customer name.

customerNostring

The customer number.

emailstring

The customer email address.

guestboolean

A flag indicating if the order was placed by a guest.

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>

The gift certificate line items.

basePricenumber (double)

The base price of the line item, which is the unit price not including adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.

grossPricenumber (double)

The gross price of the line item before applying any adjustments.

itemTextstring

The text describing the item.

netPricenumber (double)

The net price of the line item before applying any adjustments.

taxnumber (double)

The tax on the line item before applying any adjustments.

taxBasisnumber (double)

The amount used to calculate the tax for this item.

giftCertificateMerchantIdstring

The ID used to identify the certificate merchant.

giftCertificateItemIdstring

The item ID.

messagestring

The gift certificate message.

recipientEmailstring

The recipient email.

recipientNamestring

The recipient name.

senderNamestring

The sender name.

shipmentIdstring

The ID of the shipment to which this item belongs.

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.

orderNostring

The order number

orderPriceAdjustmentsarray<object>

The order-level price adjustments.

basePricenumber (double)

The adjustment amount. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.

grossPricenumber (double)

The adjustment amount, including tax.

itemTextstring

The text describing the adjustment.

netPricenumber (double)

The adjustment amount, not including tax.

taxnumber (double)

The tax on the adjustment amount.

taxBasisnumber (double)

The amount used to calculate the tax for this adjustment.

abTestSegmentany

The AB testing segment, if enabled for the site and applicable to this price adjustment.

appliedDiscountany

Details describing the discount on which this price adjustment is based. For adjustments not based on a discount, this value is null.

campaignIdstring

The campaign ID of the promotion on which this price adjustment is based. For adjustments not based on a promotion, this value is null. For adjustments based on an AB test promotion, this value is not null, but isn't meaningful.

couponCodestring

The coupon code of the coupon on which this price adjustment is based. For adjustments not based on a coupon, this value is null.

createdBystring

The user who created the price adjustment.

creationDatestring (date-time)

The timestamp when the price adjustment was created.

customboolean

A flag indicating whether this price adjustment was created by custom logic. This flag is set to true unless the price adjustment was created by the promotion engine.

lastModifiedstring (date-time)

The timestamp when the price adjustment was last modified.

manualboolean

A flag indicating whether this price adjustment was created by a manual process. If the price adjustment was created by the promotion engine, this value is always false.

priceAdjustmentIdstring

The price adjustment ID.

promotionIdstringrequired

The promotion ID of the promotion on which this price adjustment is based. Custom price adjustment can assign an arbitrary promotion ID, but it must not be used by the promotion engine. If no promotion ID is specified, then the system assigns a generated ID.

reasonCodestring

The reason code why this price adjustment was made.

orderTotalnumber (double)

The total price, including products, shipping and, tax.

paymentInstrumentsarray<object>

The payment instruments list.

bankRoutingNumberstring

The bank routing number.

maskedGiftCertificateCodestring

The gift certificate code with the last 4 characters not masked.

paymentCardany

The payment card.

paymentInstrumentIdstring

The payment instrument ID.

paymentMethodIdstring

The payment method ID.

paymentTransactionany

The payment transaction.

paymentStatusstring

The order payment status.

One ofpaidpart_paidnot_paid

placeDatestring (date-time)

The timestamp when the order was placed.

productItemsarray<object>

The product items.

basePricenumber (double)

The base price of the line item, which is the unit price not including adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.

grossPricenumber (double)

The gross price of the line item before applying any adjustments.

itemTextstring

The text describing the item.

netPricenumber (double)

The net price of the line item before applying any adjustments.

taxnumber (double)

The tax on the line item before applying any adjustments.

taxBasisnumber (double)

The amount used to calculate the tax for this item.

adjustedTaxnumber (double)

The tax on the line item, including any adjustments.

bonusDiscountLineItemIdstring

The ID of the bonus discount line item to which this bonus product relates.

bonusProductLineItemboolean

A flag indicating whether this item is a bonus product.

brandstring
bundledProductItemsarray<object>

The bundled product items.

externalLineItemStatusstring

The external line item status.

externalLineItemTextstring

The external line item text.

giftboolean

Returns true if the item is a gift.

giftMessagestring

The gift message.

inventoryIdstring

The inventory list ID associated with this item.

itemIdstring

The product item ID. Use this to identify this item when updating its quantity or creating a custom price adjustment for it.

minOrderQuantitynumber (double)

The minimum order quantity for this product.

optionItemsarray<object>11 fields

The option items.

positionnumber (double)

The position of the product line item.

priceAdjustmentsarray<object>18 fields

The price adjustments.

priceAfterItemDiscountnumber (double)

The price of the product line item 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.

priceAfterOrderDiscountnumber (double)

The price of the product line item 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.

productIdstringrequired

The id (SKU) of the product.

productListItemany

If this product line item was added from a product list, this value is a reference to the corresponding product list item.

productNamestring

The name of the product.

quantitynumber (double)

The ordered quantity of the products represented by this item.

shipmentIdstringrequired

The ID of the shipment to which this item belongs.

shippingItemIdstring

If the product line item has a related shipping item, this value is the shipping item ID. A related shipping item represents a surcharge applied to individual products using a particular shipping method.

stepQuantitynumber (double)
taxRatenumber (double)required

The tax rate applicable to this product line item. For a 10% tax rate, the value is 0.1.

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>

The shipments.

adjustedMerchandizeTotalTaxnumber (double)

The total tax on products in the shipment, including item-level price adjustments but not including service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments.

adjustedShippingTotalTaxnumber (double)

The total tax on shipping charges in the shipment, including shipping price adjustments.

giftboolean

A flag indicating whether the shipment is a gift.

giftMessagestring

The gift message.

merchandizeTotalTaxnumber (double)

The total tax on products in the shipment, not including price adjustments or service charges such as shipping.

productSubTotalnumber (double)

The total price of all products in the shipment, 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 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.

shipmentIdstringrequired

The order-specific ID of the shipment. The default value is 'me'.

shipmentNostringrequired

The shipment number of this shipment. This number is automatically generated.

shipmentTotalnumber (double)

The total price of all products in the shipment including item-level adjustments, shipping charges, and tax.

shippingAddressany

The shipping address.

shippingMethodany

The shipping method.

shippingStatusstring

The shipping status of the shipment.

One ofnot_shippedshipped

shippingTotalnumber (double)

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

shippingTotalTaxnumber (double)

The total tax on shipping charges in the shipment, not including shipping price adjustments.

taxTotalnumber (double)

The total tax on the shipment, including item-level price adjustments and service charges such as shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. This field value must match the summed up taxTotal, and an InvalidTaxTotalException is thrown if the values do not match.

trackingNumberstring

The tracking number of the shipment.

shippingItemsarray<object>

The shipping items.

basePricenumber (double)

The base price of the shipping item, which is the unit price not including adjustments. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax.

grossPricenumber (double)

The gross price of the shipping item before applying any adjustments.

itemTextstring

The text describing the shipping item.

netPricenumber (double)

The net price of the shipping item before applying any adjustments.

taxnumber (double)

The tax for the shipping item, not including price adjustments.

taxBasisnumber (double)

The amount used to calculate the tax for this shipping item.

adjustedTaxnumber (double)

The tax for the shipping item, including price adjustments.

itemIdstring

The shipping item ID. Use this value to identify this shipping item when updating its quantity or creating a custom price adjustment for it.

priceAdjustmentsarray<object>18 fields

The price adjustments.

priceAfterItemDiscountnumber (double)

The price of the shipping item 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.

shipmentIdstring

The ID of the shipment to which this item belongs.

taxRatenumber (double)required

The tax rate applicable to this shipping line item. For a 10% tax rate, the value is 0.1.

typestring

The type of shipping charge applicable to this shipping item.

One offixed_pricesurchargeDefault "fixed_price"

shippingStatusstring

The order shipping status.

One ofshippedpart_shippednot_shipped

json
{
  "orderNo": "00000410",
  "adjustedMerchandizeTotalTax": 4.95,
  "adjustedShippingTotalTax": 0.3,
  "affiliatePartnerId": "PARTNER_US_001",
  "affiliatePartnerName": "PARTNER_US_001",
  "billingAddress": null,
  "bonusDiscountLineItems": [
    {
      "bonusProducts": [
        {
          "productId": "apple-ipod-classic",
          "productName": "Nintendo DS Game Console"
        }
      ],
      "couponCode": "5ties",
      "id": "91f4dd8bfa0653d58b7783b04f",
      "maxBonusItems": 0,
      "promotionId": "Buy1Get2"
    }
  ],
  "businessType": "b2c",
  "cancelCode": "canceled",
  "cancelDescription": "Ordered by mistake.",
  "channelType": "storefront",
  "confirmationStatus": "confirmed"
}

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

Was this page helpful?
Get Order 2 — Salesforce Commerce Cloud — Documentation