Shipping API reference

The checkout module provides REST and GraphQL APIs to configure out-of-process shipping methods. These methods depend on webhooks to obtain shipping rates.

The App Builder application actions can act as webhook endpoints to communicate between Adobe Commerce and the shipping provider.

REST

To configure out-of-process shipping methods, add shipping carriers using the REST API.

The raw Shipping REST schema is available here.

To register a new out-of-process carrier, make a POST request to /V1/oope_shipping_carrier with the carrier information, such as code and title:

Copy
curl --request POST \
--url <ADOBE_COMMERCE_URL>/rest/all/V1/oope_shipping_carrier \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"carrier": {
"code": "DPS",
"title": "Detroit Postal Service"
"stores": ["default", "custom"],
"countries": ["DE","FR","CA"],
"sort_order": 10000,
"active": true,
"tracking_available": false,
"shipping_labels_available": false
}
}'
Copied to your clipboard
curl --request POST \
--url <ADOBE_COMMERCE_URL>/rest/all/V1/oope_shipping_carrier \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"carrier": {
"code": "DPS",
"title": "Detroit Postal Service"
"stores": ["default", "custom"],
"countries": ["DE","FR","CA"],
"sort_order": 10000,
"active": true,
"tracking_available": false,
"shipping_labels_available": false
}
}'

Example of the update request:

Copy
curl --request PUT \
--url <ADOBE_COMMERCE_URL>/rest/all/V1/oope_shipping_carrier \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"carrier": {
"code": "DEPS",
"title": "Demo postal service",
"stores": ["default"],
"countries": ["DE","FR","CA"],
"sort_order": 10000,
"active": true,
"tracking_available": false,
"shipping_labels_available": false
}
}'
Copied to your clipboard
curl --request PUT \
--url <ADOBE_COMMERCE_URL>/rest/all/V1/oope_shipping_carrier \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"carrier": {
"code": "DEPS",
"title": "Demo postal service",
"stores": ["default"],
"countries": ["DE","FR","CA"],
"sort_order": 10000,
"active": true,
"tracking_available": false,
"shipping_labels_available": false
}
}'

GraphQL

The GraphQL schema allows providing additional data for out-of-process shipping methods. The additional_data is added to selected_shipping_method and available_shipping_methods in cart queries.

The raw Shipping GraphQL schema is available here.

The additional_data is a list of key-value pairs that can store additional information about the shipping method.

Copy
additional_data {
    key
    value
}
Copied to your clipboard
additional_data {
    key
    value
}

For example, when setting shipping methods on cart mutations:

Copy
mutation {
  setShippingMethodsOnCart(input: {
    cart_id: "<cart_id>"
    shipping_methods: [
      {
        carrier_code: "EPS"
        method_code: "eps_shipping_two"
      }
    ]
  }) {
    cart {
      shipping_addresses {
        selected_shipping_method {
            additional_data {
                key
                value
            }
            carrier_code
            carrier_title
            method_code
            method_title
            price_excl_tax {
                currency
                value
            }
        }
      }
    }
  }
}
Copied to your clipboard
mutation {
  setShippingMethodsOnCart(input: {
    cart_id: "<cart_id>"
    shipping_methods: [
      {
        carrier_code: "EPS"
        method_code: "eps_shipping_two"
      }
    ]
  }) {
    cart {
      shipping_addresses {
        selected_shipping_method {
            additional_data {
                key
                value
            }
            carrier_code
            carrier_title
            method_code
            method_title
            price_excl_tax {
                currency
                value
            }
        }
      }
    }
  }
}

Additionally, you can use additional_data in a query to get carts with available shipping methods:

Copy
{
  cart(cart_id: "<cart_id>") {
    shipping_addresses {
      available_shipping_methods {
        additional_data {
          key
          value
        }
        amount {
          currency
          value
        }
        available
        carrier_code
        carrier_title
        method_code
        method_title
        price_excl_tax {
          value
          currency
        }
        price_incl_tax {
          value
          currency
        }
      }
      selected_shipping_method {
        amount {
          value
          currency
        }
        carrier_code
        carrier_title
        method_code
        method_title
      }
    }
    itemsV2 {
        items {
            uid
            product {
                sku
            }

        } 
    }
  } 
}
Copied to your clipboard
{
  cart(cart_id: "<cart_id>") {
    shipping_addresses {
      available_shipping_methods {
        additional_data {
          key
          value
        }
        amount {
          currency
          value
        }
        available
        carrier_code
        carrier_title
        method_code
        method_title
        price_excl_tax {
          value
          currency
        }
        price_incl_tax {
          value
          currency
        }
      }
      selected_shipping_method {
        amount {
          value
          currency
        }
        carrier_code
        carrier_title
        method_code
        method_title
      }
    }
    itemsV2 {
        items {
            uid
            product {
                sku
            }

        } 
    }
  } 
}

Last updated 2/11/2025

Was this helpful?

Yes

No