> ## Documentation Index
> Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

**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



## OpenAPI

````yaml /subscription/admin-api-swagger.json post /api/external/v2/delivery-profiles/v2/create-shipping-profile
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing subscriptions, payments, and
    related operations. These APIs allow you to programmatically manage
    subscription lifecycles, handle payments, configure products, and integrate
    subscription functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://subscription-admin.appstle.com
security: []
tags:
  - description: >-
      Core APIs for managing the complete subscription lifecycle including
      creation, updates, pausing, resuming, and cancellation of subscriptions.
    name: Subscription Management
  - description: >-
      APIs for managing subscription payment methods, processing payments,
      handling payment retries, and updating billing information.
    name: Subscription Payments
  - description: >-
      APIs for managing subscription contracts including delivery schedules,
      pricing, order notes, billing cycles, and shipping addresses.
    name: Subscription Contracts
  - description: >-
      APIs for managing products within subscriptions including adding,
      removing, updating quantities, and swapping products.
    name: Subscription Products
  - description: >-
      APIs for handling billing operations, payment processing, and financial
      transactions related to subscriptions.
    name: Billing & Payments
  - description: >-
      APIs for managing discounts and promotional codes applied to
      subscriptions.
    name: Subscription Discounts
  - description: >-
      APIs for managing one-time add-on products that can be purchased alongside
      recurring subscription items.
    name: Subscription One-Time Products
  - description: >-
      APIs for managing subscription plans, pricing tiers, and plan
      configurations.
    name: Subscription Plans
  - description: >-
      APIs for managing customizable product boxes and bundles where customers
      can select multiple items.
    name: Build-a-Box & Bundles
  - description: >-
      APIs for managing the product catalog including product information,
      variants, and inventory.
    name: Product Catalog
  - description: >-
      APIs for managing operational settings, configurations, and administrative
      functions.
    name: Operations & Settings
  - description: >-
      APIs powering the customer-facing portal where subscribers can manage
      their own subscriptions.
    name: Customer Portal
  - description: APIs for managing customer information, profiles, and account details.
    name: Customers
  - description: >-
      APIs for retrieving aggregated subscription data, customer subscription
      history, and account-level subscription information.
    name: Subscription Data
  - description: >-
      APIs for managing delivery profiles, shipping rates, free shipping
      configuration, and delivery method options on subscriptions.
    name: Delivery & Shipping
  - description: >-
      APIs for managing storefront customization including custom CSS, theme
      settings, label translations, and merchant-defined widget configuration.
    name: Customization
  - description: >-
      APIs for configuring cancellation flows, retention offers, cancellation
      reason management, and win-back automation.
    name: Customer Retention
paths:
  /api/external/v2/delivery-profiles/v2/create-shipping-profile:
    post:
      tags:
        - Operations & Settings
        - Delivery & Shipping
      summary: Create a new shipping/delivery profile (V2)
      description: >-
        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.


        **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
      operationId: createShippingProfileV2External
      parameters:
        - description: API Key (Deprecated - Use Header X-API-Key instead)
          in: query
          name: api_key
          required: false
          schema:
            type: string
        - in: header
          name: X-API-Key
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShippingProfileRequestV2'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Delivery profile created successfully
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Invalid request parameters or validation error
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Authentication required
        '403':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Insufficient permissions to create delivery profiles
        '422':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Unable to process delivery profile due to Shopify API constraints
components:
  schemas:
    CreateShippingProfileRequestV2:
      description: Shipping Profile Request View Modelf
      properties:
        id:
          type: string
        locationInfos:
          items:
            $ref: '#/components/schemas/LocationInfo'
          type: array
        name:
          type: string
      type: object
    DeliveryProfileDTO:
      properties:
        deliveryProfileId:
          type: string
        id:
          format: int64
          type: integer
        name:
          type: string
        sellerGroupIds:
          items:
            type: string
          type: array
          uniqueItems: true
        shop:
          type: string
      required:
        - deliveryProfileId
        - shop
      type: object
    LocationInfo:
      properties:
        countryInfos:
          items:
            $ref: '#/components/schemas/CountryInfo'
          type: array
        locationId:
          type: string
      type: object
    CountryInfo:
      properties:
        code:
          type: string
        deliveryMethodInfo:
          items:
            $ref: '#/components/schemas/DeliveryMethodInfo'
          type: array
        provinceCode:
          type: string
        restOfWorld:
          type: boolean
        shouldIncludeAllProvince:
          type: boolean
      type: object
    DeliveryMethodInfo:
      properties:
        amount:
          format: double
          type: number
        carrierRate:
          type: boolean
        carrierServiceId:
          type: string
        currencyCode:
          enum:
            - USD
            - EUR
            - GBP
            - CAD
            - AFN
            - ALL
            - DZD
            - AOA
            - ARS
            - AMD
            - AWG
            - AUD
            - BBD
            - AZN
            - BDT
            - BSD
            - BHD
            - BIF
            - BYN
            - BZD
            - BMD
            - BTN
            - BAM
            - BRL
            - BOB
            - BWP
            - BND
            - BGN
            - MMK
            - KHR
            - CVE
            - KYD
            - XAF
            - CLP
            - CNY
            - COP
            - KMF
            - CDF
            - CRC
            - HRK
            - CZK
            - DKK
            - DJF
            - DOP
            - XCD
            - EGP
            - ERN
            - ETB
            - FKP
            - XPF
            - FJD
            - GIP
            - GMD
            - GHS
            - GTQ
            - GYD
            - GEL
            - GNF
            - HTG
            - HNL
            - HKD
            - HUF
            - ISK
            - INR
            - IDR
            - ILS
            - IRR
            - IQD
            - JMD
            - JPY
            - JEP
            - JOD
            - KZT
            - KES
            - KID
            - KWD
            - KGS
            - LAK
            - LVL
            - LBP
            - LSL
            - LRD
            - LYD
            - LTL
            - MGA
            - MKD
            - MOP
            - MWK
            - MVR
            - MRU
            - MXN
            - MYR
            - MUR
            - MDL
            - MAD
            - MNT
            - MZN
            - NAD
            - NPR
            - ANG
            - NZD
            - NIO
            - NGN
            - NOK
            - OMR
            - PAB
            - PKR
            - PGK
            - PYG
            - PEN
            - PHP
            - PLN
            - QAR
            - RON
            - RUB
            - RWF
            - WST
            - SHP
            - SAR
            - RSD
            - SCR
            - SLL
            - SGD
            - SDG
            - SOS
            - SYP
            - ZAR
            - KRW
            - SSP
            - SBD
            - LKR
            - SRD
            - SZL
            - SEK
            - CHF
            - TWD
            - THB
            - TJS
            - TZS
            - TOP
            - TTD
            - TND
            - TRY
            - TMT
            - UGX
            - UAH
            - AED
            - UYU
            - UZS
            - VUV
            - VES
            - VND
            - XOF
            - YER
            - ZMW
            - USDC
            - BYR
            - STD
            - STN
            - VED
            - VEF
            - XXX
            - $UNKNOWN
          type: string
        deliveryConditionType:
          type: string
        name:
          type: string
        priceConditions:
          items:
            $ref: '#/components/schemas/PriceCondition'
          type: array
        weightConditions:
          items:
            $ref: '#/components/schemas/WeightCondition'
          type: array
      type: object
    PriceCondition:
      properties:
        amount:
          format: double
          type: number
        deliverCondtion:
          type: string
      type: object
    WeightCondition:
      properties:
        deliveryCondition:
          type: string
        weight:
          format: double
          type: number
        weightUnit:
          type: string
      type: object

````