Get Shipping Groups By Id

Retrieve a specific shipping group for an order

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

Use it in a workflow

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

Request

Path parameters

orderIDstringrequired

The ID of the order

shippingGroupIDstringrequired

The ID of the shipping group

Query parameters

includestring

A comma-separated list of related resources to include in the response.

Response

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

dataobject

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

includedobject

Related objects that are included in the response when using the include query parameter.

itemsarray<object>24 fields

Array of order items associated with this shipping group.

errorsarray<object>

Array of validation or processing errors

titlestringrequired

A brief summary of the error.

statusstring | integerrequired

The HTTP response code of the error.

detailstring

Optional additional detail about the error.

sourcestring

The field or location that caused the validation error. For JSON schema validation errors, this contains the JSON path to the invalid field (e.g., 'data.name', 'request', 'data.items[0].quantity').

metaobject13 fields

Additional metadata associated with the error. May include arbitrary keys.

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"
  },
  "included": {
    "items": [
      {
        "type": "string",
        "id": "00000000-0000-0000-0000-000000000000",
        "quantity": 0,
        "product_id": "00000000-0000-0000-0000-000000000000",
        "subscription_offering_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "sku": "string",
        "location": "string",
        "unit_price": {
          "amount": 0,
          "currency": "string",
          "includes_tax": false
        },
        "value": {
          "amount": 0,
          "currency": "string",
          "includes_tax": false
        },
        "discounts": [
          {
            "amount": {
              "amount": null,
              "currency": null,
              "includes_tax": null
            },
            "code": "string",
            "id": "00000000-0000-0000-0000-000000000000",
            "promotion_source": "string",
            "is_cart_discount": false,
            "ordinal": 0,
            "promotion_action_id": "string"
          }
        ],
        "links": {}
      }
    ]
  },
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string",
      "source": "string",
      "meta": {
        "id": "string",
        "ids": [
          "string"
        ],
        "item_ids": [
          "string"
        ],
        "shipping_group_id": "string",
        "shipping_group_ids": [
          "string"
        ],
        "cart_id": "string",
        "code": "string",
        "order_id": "string",
        "sku": "string",
        "email": "name@example.com",
        "component_product_id": "00000000-0000-0000-0000-000000000000",
        "error-meta-key": "string"
      }
    }
  ]
}

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

Was this page helpful?