Spree Commerce Shipping Methods API

openapi: 3.0.3
info:
  title: Admin Account / Address Shipping Methods API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: "Spree Admin API v3 - Administrative API for managing products, orders, and store settings.\n\n## Authentication\n\nThe Admin API requires a secret API key passed in the `x-spree-api-key` header.\nSecret API keys can be generated in the Spree admin dashboard.\n\n## Response Format\n\nAll responses are JSON. List endpoints return paginated responses with `data` and `meta` keys.\nSingle resource endpoints return a flat JSON object.\n\n## Resource IDs\n\nEvery resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,\n`variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,\nrequest bodies, and Ransack filters all accept them directly.\n\n## Error Handling\n\nErrors return a consistent format:\n```json\n{\n  \"error\": {\n    \"code\": \"validation_error\",\n    \"message\": \"Validation failed\",\n    \"details\": { \"name\": [\"can't be blank\"] }\n  }\n}\n```\n"
  version: v3
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: localhost:3000
tags:
- name: Shipping Methods
paths:
  /api/v2/platform/shipping_methods:
    get:
      summary: Return a list of Shipping Methods
      tags:
      - Shipping Methods
      security:
      - bearer_auth: []
      description: Returns a list of Shipping Methods
      operationId: shipping-methods-list
      parameters:
      - name: page
        in: query
        example: 1
        schema:
          type: integer
      - name: per_page
        in: query
        example: 50
        schema:
          type: integer
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: calculator,shipping_categories,shipping_rates,tax_category
        schema:
          type: string
      - name: filter[name]
        in: query
        description: ''
        example: DHL Express
        schema:
          type: string
      - name: filter[title_cont]
        in: query
        description: ''
        example: About Us
        schema:
          type: string
      responses:
        '200':
          description: Records returned
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                    - id: '77'
                      type: shipping_method
                      attributes:
                        name: UPS Ground
                        code: UPS_GROUND
                        admin_name: null
                        display_on: both
                        tracking_url: null
                        created_at: '2022-11-08T19:35:23.928Z'
                        updated_at: '2022-11-08T19:35:23.928Z'
                        deleted_at: null
                        public_metadata: {}
                        private_metadata: {}
                      relationships:
                        shipping_categories:
                          data:
                          - id: '146'
                            type: shipping_category
                        shipping_rates:
                          data: []
                        tax_category:
                          data: null
                        calculator:
                          data:
                            id: '137'
                            type: calculator
                    - id: '78'
                      type: shipping_method
                      attributes:
                        name: UPS Ground
                        code: UPS_GROUND
                        admin_name: null
                        display_on: both
                        tracking_url: null
                        created_at: '2022-11-08T19:35:23.939Z'
                        updated_at: '2022-11-08T19:35:23.939Z'
                        deleted_at: null
                        public_metadata: {}
                        private_metadata: {}
                      relationships:
                        shipping_categories:
                          data:
                          - id: '146'
                            type: shipping_category
                        shipping_rates:
                          data: []
                        tax_category:
                          data: null
                        calculator:
                          data:
                            id: '138'
                            type: calculator
                    meta:
                      count: 2
                      total_count: 2
                      total_pages: 1
                    links:
                      self: http://www.example.com/api/v2/platform/shipping_methods?page=1&per_page=&include=&filter[name]=&filter[title_cont]=
                      next: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
                      prev: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
                      last: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
                      first: http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
              schema:
                $ref: '#/components/schemas/resources_list'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
    post:
      summary: Create a Shipping Method
      tags:
      - Shipping Methods
      security:
      - bearer_auth: []
      description: Creates a Shipping Method
      operationId: create-shipping-method
      parameters:
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: calculator,shipping_categories,shipping_rates,tax_category
        schema:
          type: string
      responses:
        '201':
          description: Record created
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '81'
                      type: shipping_method
                      attributes:
                        name: DHL Express Domestic
                        code: DDD
                        admin_name: DHL Express- Zone A
                        display_on: both
                        tracking_url: null
                        created_at: '2022-11-08T19:35:24.485Z'
                        updated_at: '2022-11-08T19:35:24.485Z'
                        deleted_at: null
                        public_metadata: {}
                        private_metadata: {}
                      relationships:
                        shipping_categories:
                          data:
                          - id: '148'
                            type: shipping_category
                        shipping_rates:
                          data: []
                        tax_category:
                          data:
                            id: '142'
                            type: tax_category
                        calculator:
                          data:
                            id: '141'
                            type: calculator
              schema:
                $ref: '#/components/schemas/resource'
        '422':
          description: Invalid request
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: Calculator can't be blank, Name can't be blank, Display on can't be blank, and You must select at least one shipping category
                    errors:
                      calculator:
                      - can't be blank
                      name:
                      - can't be blank
                      display_on:
                      - can't be blank
                      base:
                      - You must select at least one shipping category
              schema:
                $ref: '#/components/schemas/validation_errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_shipping_method_params'
  /api/v2/platform/shipping_methods/{id}:
    get:
      summary: Return a Shipping Method
      tags:
      - Shipping Methods
      security:
      - bearer_auth: []
      description: Returns a Shipping Method
      operationId: show-shipping-method
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: calculator,shipping_categories,shipping_rates,tax_category
        schema:
          type: string
      responses:
        '200':
          description: Record found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '82'
                      type: shipping_method
                      attributes:
                        name: UPS Ground
                        code: UPS_GROUND
                        admin_name: null
                        display_on: both
                        tracking_url: null
                        created_at: '2022-11-08T19:35:24.769Z'
                        updated_at: '2022-11-08T19:35:24.769Z'
                        deleted_at: null
                        public_metadata: {}
                        private_metadata: {}
                      relationships:
                        shipping_categories:
                          data:
                          - id: '149'
                            type: shipping_category
                        shipping_rates:
                          data: []
                        tax_category:
                          data: null
                        calculator:
                          data:
                            id: '142'
                            type: calculator
              schema:
                $ref: '#/components/schemas/resource'
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
    patch:
      summary: Update a Shipping Method
      tags:
      - Shipping Methods
      security:
      - bearer_auth: []
      description: Updates a Shipping Method
      operationId: update-shipping-method
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: calculator,shipping_categories,shipping_rates,tax_category
        schema:
          type: string
      responses:
        '200':
          description: Record updated
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '84'
                      type: shipping_method
                      attributes:
                        name: FedEx Expedited
                        code: UPS_GROUND
                        admin_name: null
                        display_on: both
                        tracking_url: null
                        created_at: '2022-11-08T19:35:25.390Z'
                        updated_at: '2022-11-08T19:35:25.626Z'
                        deleted_at: null
                        public_metadata: {}
                        private_metadata: {}
                      relationships:
                        shipping_categories:
                          data:
                          - id: '151'
                            type: shipping_category
                        shipping_rates:
                          data: []
                        tax_category:
                          data: null
                        calculator:
                          data:
                            id: '145'
                            type: calculator
              schema:
                $ref: '#/components/schemas/resource'
        '422':
          description: Invalid request
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: Name can't be blank
                    errors:
                      name:
                      - can't be blank
              schema:
                $ref: '#/components/schemas/validation_errors'
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_shipping_method_params'
    delete:
      summary: Delete a Shipping Method
      tags:
      - Shipping Methods
      security:
      - bearer_auth: []
      description: Deletes a Shipping Method
      operationId: delete-shipping-method
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Record deleted
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    update_shipping_method_params:
      type: object
      properties:
        shipping_method:
          type: object
          properties:
            name:
              type: string
              example: DHL Express
            admin_name:
              type: string
              example: DHL Area Code D
            code:
              type: string
              example: DHL-A-D
            tracking_url:
              type: string
              example: dhlexpress.com?tracking=
            display_on:
              type: string
              example: both
              enum:
              - both
              - back_end
              - front_end
            tax_category_id:
              type: string
              example: '1'
            shipping_category_ids:
              type: array
              items:
                allOf:
                - type: string
                  example: '2'
            calculator_attributes:
              $ref: '#/components/schemas/shipping_calculator_params'
            public_metadata:
              type: object
            private_metadata:
              type: object
      required:
      - shipping_method
      x-internal: false
    create_shipping_method_params:
      type: object
      properties:
        shipping_method:
          type: object
          required:
          - name
          - display_on
          - shipping_category_ids
          properties:
            name:
              type: string
              example: DHL Express
            admin_name:
              type: string
              example: DHL Area Code D
            code:
              type: string
              example: DHL-A-D
            tracking_url:
              type: string
              example: dhlexpress.com?tracking=
            display_on:
              type: string
              example: both
              enum:
              - both
              - back_end
              - front_end
            tax_category_id:
              type: string
              example: '1'
            shipping_category_ids:
              type: array
              items:
                allOf:
                - type: string
                  example: '2'
            calculator_attributes:
              $ref: '#/components/schemas/shipping_calculator_params'
            public_metadata:
              type: object
            private_metadata:
              type: object
      required:
      - shipping_method
      x-internal: false
    resource_properties:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
        relationships:
          type: object
      required:
      - id
      - type
      - attributes
      x-internal: false
    shipping_calculator_params:
      type: object
      properties:
        type:
          type: string
          example: Spree::Calculator::Shipping::FlatPercentItemTotal
          enum:
          - Spree::Calculator::Shipping::DigitalDelivery
          - Spree::Calculator::Shipping::FlatPercentItemTotal
          - Spree::Calculator::Shipping::FlatRate
          - Spree::Calculator::Shipping::FlexiRate
          - Spree::Calculator::Shipping::PerItem
          - Spree::Calculator::Shipping::PriceSack
      required:
      - type
      x-internal: false
    error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
      x-internal: false
    resources_list:
      type: object
      properties:
        data:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/resource_properties'
        meta:
          type: object
          properties:
            count:
              type: integer
            total_count:
              type: integer
            total_pages:
              type: integer
          required:
          - count
          - total_count
          - total_pages
        links:
          type: object
          properties:
            self:
              type: string
            next:
              type: string
            prev:
              type: string
            last:
              type: string
            first:
              type: string
          required:
          - self
          - next
          - prev
          - last
          - first
      required:
      - data
      - meta
      - links
      x-internal: false
    resource:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/resource_properties'
      required:
      - data
      x-internal: false
    validation_errors:
      type: object
      properties:
        error:
          type: string
        errors:
          type: object
      required:
      - error
      - errors
      x-internal: false
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication
x-tagGroups:
- name: Authentication
  tags:
  - Authentication
- name: Products & Catalog
  tags:
  - Products
  - Variants
  - Option Types
  - Custom Fields
  - Channels
- name: Pricing
  tags:
  - Pricing
  - Markets
- name: Orders & Fulfillment
  tags:
  - Orders
  - Payments
  - Fulfillments
  - Refunds
- name: Customers
  tags:
  - Customers
  - Customer Groups
- name: Promotions & Gift Cards
  tags:
  - Promotions
  - Gift Cards
- name: Data
  tags:
  - Exports
- name: Configuration
  tags:
  - Settings
  - Stock Locations
  - Payment Methods
  - Staff
  - API Keys
  - Allowed Origins
  - Webhooks