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

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



## OpenAPI

````yaml /memberships/admin-api-swagger.json post /api/external/v2/delivery-profiles/create-shipping-profile
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for managing memberships, payments, and
    related operations. These APIs allow you to programmatically manage
    membership lifecycles, handle payments, configure products, and integrate
    membership functionality into your applications.
  title: Admin APIs
  version: 0.0.1
servers:
  - url: https://membership-admin.appstle.com
security: []
tags:
  - description: >-
      APIs for managing Shopify delivery profiles, shipping rates, zones, and
      free shipping configuration for subscription memberships
    name: Shipping & Delivery Profiles
  - description: >-
      APIs for retrieving historical discount code usage and redemption
      information for membership contracts
    name: Customer Discount History
  - description: >-
      APIs for managing membership cancellation flow settings including
      retention offers, survey questions, and cancel confirmation screens
    name: Cancellation Flow Configuration
  - description: >-
      APIs for managing membership billing attempts, recurring orders, payment
      retries, order history, and order skipping
    name: Billing & Orders
  - description: >-
      APIs for managing one-time product additions to upcoming subscription
      orders, including adding, retrieving, and removing one-off items
    name: One-Time Add-Ons
  - description: >-
      APIs for managing membership/subscription plan groups, including creating
      plans, configuring discounts, billing intervals, and assigning products to
      plans
    name: Membership Plans
  - description: >-
      APIs for managing subscription product bundles, bundle configurations,
      item grouping, and bundle-specific discount codes
    name: Product Bundles
  - description: >-
      APIs for retrieving custom CSS styles applied to subscription widgets and
      customer portal for theme customization
    name: Custom CSS Styling
  - description: >-
      APIs for managing customer portal settings including UI customization,
      text labels, feature toggles, and branding options for the member
      self-service portal
    name: Customer Portal Configuration
  - description: >-
      APIs for managing membership/subscription contracts including creation,
      updates, status changes, line items, discounts, and billing operations
    name: Membership Contracts
  - description: >-
      APIs for managing subscription bundle configuration settings including
      bundle behavior, pricing rules, and display options
    name: Bundle Settings
  - description: >-
      APIs for managing customer payment methods, payment tokens, and payment
      method retrieval for subscriptions
    name: Customer Payment Methods
  - description: >-
      APIs for retrieving product swap/substitution options allowing members to
      exchange subscription items based on configured swap rules and variant
      groups
    name: Product Swap Rules
  - description: >-
      APIs for retrieving product catalog, variants, pricing, and inventory
      information for subscription memberships.
    name: Product & Inventory Data
  - description: >-
      APIs for managing shop-level membership settings, configuration, and
      general store information.
    name: Shop Settings
  - description: >-
      APIs for performing bulk/mass operations on multiple membership contracts
      including status updates, product replacements, and billing date changes.
    name: Bulk Operations
paths:
  /api/external/v2/delivery-profiles/create-shipping-profile:
    post:
      tags:
        - Shipping & Delivery Profiles
      summary: Create shipping/delivery profile (V1 format - Legacy)
      description: >-
        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.


        **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
      operationId: createShippingProfileV2
      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/CreateShippingProfileRequestVM'
        description: >-
          Delivery profile configuration with country zones and shipping rates
          (V1 format)
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Delivery profile successfully created in Shopify
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Invalid request - validation failed
        '401':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Authentication required - invalid or missing API key
        '500':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DeliveryProfileDTO'
          description: Shopify API error during profile creation
components:
  schemas:
    CreateShippingProfileRequestVM:
      properties:
        countryInfos:
          items:
            $ref: '#/components/schemas/DeliveryCountryInfo'
          type: array
        deliveryMethodInfo:
          items:
            $ref: '#/components/schemas/DeliveryMethodInfo'
          type: array
        id:
          format: int64
          type: integer
        locationInfos:
          items:
            $ref: '#/components/schemas/LocationInfo'
          type: array
        name:
          type: string
        restOfWorld:
          type: boolean
      type: object
    DeliveryProfileDTO:
      properties:
        deliveryProfileId:
          description: Shopify delivery profile ID
          type: string
        id:
          description: Unique identifier of the delivery profile
          example: 201
          format: int64
          type: integer
        name:
          description: Display name of the delivery profile
          example: Standard Shipping
          type: string
        sellerGroupIds:
          description: Set of selling plan group IDs associated with this delivery profile
          items:
            description: >-
              Set of selling plan group IDs associated with this delivery
              profile
            type: string
          type: array
          uniqueItems: true
        shop:
          description: Shop domain identifier
          example: my-store.myshopify.com
          type: string
      required:
        - deliveryProfileId
        - shop
      type: object
    DeliveryCountryInfo:
      properties:
        code:
          type: string
        provinceCode:
          type: string
        restOfWorld:
          type: boolean
        shouldIncludeAllProvince:
          type: boolean
      type: object
    DeliveryMethodInfo:
      properties:
        amount:
          format: double
          type: number
        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
        name:
          type: string
        priceConditions:
          items:
            $ref: '#/components/schemas/PriceCondition'
          type: array
        weightConditions:
          items:
            $ref: '#/components/schemas/WeightCondition'
          type: array
      type: object
    LocationInfo:
      properties:
        countryInfos:
          items:
            $ref: '#/components/schemas/CountryInfo'
          type: array
        locationId:
          type: string
      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
    CountryInfo:
      properties:
        code:
          type: string
        deliveryMethodInfo:
          items:
            $ref: '#/components/schemas/DeliveryMethodInfo'
          type: array
        provinceCode:
          type: string
        restOfWorld:
          type: boolean
        shouldIncludeAllProvince:
          type: boolean
      type: object

````