Create a new shipping/delivery profile (V3)

Creates a new shipping or delivery profile for subscription orders using the V3 request format. This is the latest version with the most comprehensive delivery profile configuration capabilities.

Full behavior, validation rules, and side effects

Enhancements in V3:

• Full support for all Shopify delivery profile features
• Advanced rate calculation options
• Support for weight-based and price-based rates
• Enhanced zone and country management
• Better handling of delivery conditions and rules

Key Features:

• Define complex shipping rate structures
• Configure multiple delivery methods per zone
• Set up conditional rates based on weight, price, or item count
• Manage detailed shipping zones with province-level granularity
• Full control over delivery profile settings

Authentication: Requires valid X-API-Key header

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

Create a new shipping/delivery profile (V3)

cURL

curl --request POST \
  --url https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v3/create-shipping-profile \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "sellingPlanGroups": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "locations": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "zones": [
    {
      "countries": [
        {
          "value": "<string>",
          "label": "<string>",
          "includeAllProvinces": true,
          "provinces": [
            {
              "label": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "restOfWorld": true,
      "deliveryMethods": [
        {
          "name": "<string>",
          "amount": 123,
          "deliveryConditionType": "<string>",
          "minValue": 123,
          "maxValue": 123,
          "weightUnit": "<string>",
          "definitionType": "<string>",
          "carrierServiceId": "<string>",
          "carrierPercentageFee": 123,
          "carrierFixedFee": 123
        }
      ]
    }
  ],
  "id": "<string>",
  "profileId": 123,
  "locationInfos": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}
'

200

{
  "name": "<string>",
  "sellingPlanGroups": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "locations": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "zones": [
    {
      "countries": [
        {
          "value": "<string>",
          "label": "<string>",
          "includeAllProvinces": true,
          "provinces": [
            {
              "label": "<string>",
              "value": "<string>"
            }
          ]
        }
      ],
      "restOfWorld": true,
      "deliveryMethods": [
        {
          "name": "<string>",
          "amount": 123,
          "deliveryConditionType": "<string>",
          "minValue": 123,
          "maxValue": 123,
          "weightUnit": "<string>",
          "definitionType": "<string>",
          "carrierServiceId": "<string>",
          "carrierPercentageFee": 123,
          "carrierFixedFee": 123
        }
      ]
    }
  ],
  "id": "<string>",
  "profileId": 123,
  "locationInfos": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ]
}

Headers

X-API-Key · string

Query Parameters

api_key · string

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

Body

application/json

name · string

sellingPlanGroups · object[]

Show child attributes

locations · object[]

Show child attributes

zones · object[]

Show child attributes

id · string

profileId · integer<int64>

locationInfos · object[]

Show child attributes

Response

200

application/json

Delivery profile created successfully

name · string

sellingPlanGroups · object[]

Show child attributes

locations · object[]

Show child attributes

zones · object[]

Show child attributes

id · string

profileId · integer<int64>

locationInfos · object[]

Show child attributes