Create shipping/delivery profile (V1 format - Legacy)

Creates a new Shopify delivery profile with shipping zones and rates using the legacy V1 format. For new integrations, prefer the V2 endpoint which supports more advanced configuration.

Full behavior, validation rules, and side effects

Key Features:

• Single Location: Configure shipping for primary store location
• Country-Based Zones: Define shipping zones by country
• Fixed Rates: Set flat shipping costs per zone
• Simple Configuration: Straightforward setup for basic shipping needs

Configuration Structure:

• Profile Name: Unique identifier for the delivery profile
• Country Codes: List of countries in the shipping zone
• Shipping Rate: Fixed price for the zone
• Method Name: Display name for the shipping option

Use Cases:

• Simple country-based flat rate shipping
• Basic free shipping configuration
• Legacy system migrations
• Single-warehouse operations

Migration Note: Consider using the V2 endpoint (/api/external/v2/delivery-profiles/v2/create-shipping-profile) for enhanced features like multi-location support, province targeting, and flexible rate types.

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

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

Create shipping/delivery profile (V1 format - Legacy)

cURL

curl --request POST \
  --url https://membership-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>",
      "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>",
              "priceConditions": [
                {
                  "amount": 123,
                  "deliverCondtion": "<string>"
                }
              ],
              "weightConditions": [
                {
                  "deliveryCondition": "<string>",
                  "weight": 123,
                  "weightUnit": "<string>"
                }
              ]
            }
          ],
          "restOfWorld": true,
          "provinceCode": "<string>"
        }
      ]
    }
  ],
  "restOfWorld": true
}
'

201

{
  "shop": "my-store.myshopify.com",
  "deliveryProfileId": "<string>",
  "id": 201,
  "sellerGroupIds": [
    "<string>"
  ],
  "name": "Standard Shipping"
}

Headers

X-API-Key · string

Query Parameters

api_key · string

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

Body

application/json

Delivery profile configuration with country zones and shipping rates (V1 format)

name · string

id · integer<int64>

deliveryMethodInfo · object[]

Show child attributes

countryInfos · object[]

Show child attributes

locationInfos · object[]

Show child attributes

restOfWorld · boolean

Response

201

application/json

Delivery profile successfully created in Shopify

shop · string · required

Shop domain identifier

Example:

"my-store.myshopify.com"

deliveryProfileId · string · required

Shopify delivery profile ID

id · integer<int64>

Unique identifier of the delivery profile

Example:

201

sellerGroupIds · string[]

Set of selling plan group IDs associated with this delivery profile

Set of selling plan group IDs associated with this delivery profile

name · string

Display name of the delivery profile

Example:

"Standard Shipping"