Get Shipping Methods For Shipment

Retrieve the shipping methods for a shipment.

GET/organizations/{organizationId}/baskets/{basketId}/shipments/{shipmentId}/shipping-methods

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Shipping Methods For Shipment action (under Shopper Baskets v1).
Fill in the fields below, then reference the result from later steps as {{getShippingMethodsForShipment.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

shipmentIdstringrequired

The ID of the shipment to be modified.

basketIdstringrequired

The ID of the basket to be modified.

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.

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

Response

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

applicableShippingMethodsarray<object>

The applicable shipping method documents. It is read only.

descriptionstring

The localized description of the shipping method.

externalShippingMethodstring

The external shipping method.

idstringrequired

The shipping method ID.

namestring

The localized name of the shipping method.

pricenumber (double)

The shipping cost total, including shipment level costs, product level fix, and surcharge costs. It is read only.

shippingPromotionsarray<object>3 fields

The array of active customer shipping promotions for this shipping method. This array can be empty.

defaultShippingMethodIdstring

The default shipping method. It is read only.

json

{
  "applicableShippingMethods": [
    {
      "id": "001",
      "description": "Order received within 7-10 business days",
      "externalShippingMethod": "string",
      "name": "Ground",
      "price": 15,
      "shippingPromotions": [
        {
          "calloutMsg": "$30 Fixed Shipping Amount Above 150",
          "promotionId": "$30FixedShippingAmountAbove150",
          "promotionName": "$30 Fixed Shipping Amount Above 150"
        }
      ]
    }
  ],
  "defaultShippingMethodId": "me"
}

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

Was this page helpful?