younifyd
Menu

Get Order Shipping Groups

Retrieve all shipping groups for an order

GET/v2/orders/{orderID}/shipping-groups

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Order Shipping Groups action (under Carts).
  3. Fill in the fields below, then reference the result from later steps as {{getOrderShippingGroups.response.data}}.

Request

Path parameters

orderIDstringrequired

The ID of the order

Response

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

dataarray<object>
typestring
idstring
relationstring
cart_idstring
order_idstring
shipping_typestring
tracking_referencestring
external_refstring

An optional external ID reference for a shipping group. It can contain alphanumeric characters, special characters, and spaces, and is not required to be unique. The maximum allowed length is 64 characters. It can be used to include an external reference from a separate company system.

addressany

Shipping address information. You must specify at least one of region (state/province) or county.

delivery_estimateobject2 fields
created_atstring (date-time)
updated_atstring (date-time)
relationshipsobject2 fields
discountsarray<object>7 fields
metaobject2 fields
json
{
  "data": [
    {
      "type": "string",
      "id": "string",
      "relation": "string",
      "cart_id": "string",
      "order_id": "string",
      "shipping_type": "string",
      "tracking_reference": "string",
      "external_ref": "string",
      "address": null,
      "delivery_estimate": {
        "start": "2025-01-01T00:00:00Z",
        "end": "2025-01-01T00:00:00Z"
      },
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.