Create a new shipping/delivery profile (V2)

Creates a new shipping or delivery profile for subscription orders using the V2 request format. This version provides enhanced configuration options for delivery methods, zones, and pricing.

Full behavior, validation rules, and side effects

Enhancements in V2:

• Improved zone configuration
• Better support for multiple delivery methods
• Enhanced rate definition capabilities
• Support for conditional delivery rates

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

Authentication: Requires valid X-API-Key header

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

Create a new shipping/delivery profile (V2)

cURL

curl --request POST \
  --url https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "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>"
        }
      ]
    }
  ],
  "id": "<string>"
}
'

200

{
  "shop": "<string>",
  "deliveryProfileId": "<string>",
  "id": 123,
  "sellerGroupIds": [
    "<string>"
  ],
  "name": "<string>"
}

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 Modelf

name · string

locationInfos · object[]

Show child attributes

id · string

Response

200

application/json

Delivery profile created successfully

shop · string · required

deliveryProfileId · string · required

id · integer<int64>

sellerGroupIds · string[]

name · string