Shopify

Shopify Shipping API

The Shipping API from Shopify — 12 operation(s) for shipping.

GitHub OpenAPI

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-shipping-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

OpenAPI Specification

shopify-shipping-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Shipping API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Shipping
paths:
  /admin/api/2020-01/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-04
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-07
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2020-10
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-2021-01
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/checkouts/{token}/shipping_rates.json:
    get:
      summary: Shopify Retrieves A List Of Available Shipping Rates For The Specified Checkout
      description: https://shopify.dev/docs/admin-api/rest/reference/sales-channels/checkout#shipping_rates-unstable
      parameters:
      - in: path
        name: token
        required: true
        schema:
          type: string
        description: token
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_checkouts_param_token_shipping_rates
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-01
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-04
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-07
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2020-10
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-2021-01
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/shipping_zones.json:
    get:
      summary: Shopify Get A List Of All Shipping Zones
      description: https://shopify.dev/docs/admin-api/rest/reference/store-properties/shippingzone#index-unstable
      parameters:
      - in: query
        name: fields
        description: comma-separated list of fields to include in the response
        schema: {}
        required: false
      tags:
      - Shipping
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_shipping_zones
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth