Create a new shipping/delivery profile

Creates a new shipping or delivery profile for subscription orders. This endpoint allows you to configure custom shipping rates, delivery methods, and shipping zones for your subscription products. Delivery profiles control how subscription products are shipped to customers.

Full behavior, validation rules, and side effects

Key Features:

• Define custom shipping rates per zone
• Configure local delivery options
• Set up local pickup methods
• Manage shipping zones and countries
• Assign profiles to specific products or variants

Delivery Method Types:

• SHIPPING: Standard shipping with carrier rates or custom rates
• LOCAL_DELIVERY: Local delivery service within specific areas
• PICKUP: Customer pickup from store locations

Important Notes:

• Each delivery profile must have a unique name
• At least one delivery method is required
• Shipping rates can be set per zone and per weight/price range
• Profiles can be assigned to subscription products to control their shipping behavior

Authentication: Requires valid X-API-Key header

POST /api/external/v2/delivery-profiles/create-shipping-profile

Create a new shipping/delivery profile

cURL

curl --request POST \
  --url https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/create-shipping-profile \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "id": 123,
  "deliveryMethodInfo": [
    {
      "amount": 123,
      "carrierServiceId": "<string>",
      "name": "<string>",
      "carrierRate": true,
      "deliveryConditionType": "<string>",
      "priceConditions": [
        {
          "amount": 123,
          "deliverCondtion": "<string>"
        }
      ],
      "weightConditions": [
        {
          "deliveryCondition": "<string>",
          "weight": 123,
          "weightUnit": "<string>"
        }
      ]
    }
  ],
  "countryInfos": [
    {
      "code": "<string>",
      "restOfWorld": true,
      "provinceCode": "<string>",
      "shouldIncludeAllProvince": true
    }
  ],
  "locationInfos": [
    {
      "locationId": "<string>",
      "countryInfos": [
        {
          "shouldIncludeAllProvince": true,
          "code": "<string>",
          "deliveryMethodInfo": [
            {
              "amount": 123,
              "carrierServiceId": "<string>",
              "name": "<string>",
              "carrierRate": true,
              "deliveryConditionType": "<string>",
              "priceConditions": [
                {
                  "amount": 123,
                  "deliverCondtion": "<string>"
                }
              ],
              "weightConditions": [
                {
                  "deliveryCondition": "<string>",
                  "weight": 123,
                  "weightUnit": "<string>"
                }
              ]
            }
          ],
          "restOfWorld": true,
          "provinceCode": "<string>"
        }
      ]
    }
  ],
  "restOfWorld": true
}
'

200

Success Response

{
  "id": "12345",
  "shop": "example-shop.myshopify.com",
  "name": "Standard Subscription Shipping",
  "shopifyDeliveryProfileId": "gid://shopify/DeliveryProfile/67890",
  "default": false,
  "locationGroupsCount": 1,
  "productsCount": 15,
  "profileLocationGroups": [
    {
      "locationGroupId": "gid://shopify/DeliveryLocationGroup/11111",
      "countries": [
        {
          "code": "US",
          "name": "United States",
          "provinces": []
        },
        {
          "code": "CA",
          "name": "Canada",
          "provinces": []
        }
      ],
      "zones": [
        {
          "methodDefinitions": [
            {
              "name": "Standard Shipping",
              "rateDefinition": {
                "price": {
                  "amount": "5.99",
                  "currencyCode": "USD"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}

Headers

X-API-Key · string

Query Parameters

api_key · string

API Key (Deprecated - Use Header X-API-Key instead)

Body

application/json

Shipping Profile Request View Model

name · string

id · integer<int64>

deliveryMethodInfo · object[]

Show child attributes

countryInfos · object[]

Show child attributes

locationInfos · object[]

Show child attributes

restOfWorld · boolean

Response

200

application/json

Delivery profile created successfully

shop · string · required

deliveryProfileId · string · required

id · integer<int64>

sellerGroupIds · string[]

name · string