Recurly Shipping Method API

openapi: 3.2.0
info:
  title: Recurly Shipping Method API
  version: v2021-02-25
  description: 'Operations tagged Shipping Method across 2 of this provider''s published API definitions: recurly-v3-v2021-02-25-api.yaml, recurly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://v3.recurly.com
- url: https://v3.eu.recurly.com
security:
- api_key: []
tags:
- name: Shipping Method
  description: Shipping methods offered to send products to customers.
paths:
  /shipping_methods:
    get:
      tags:
      - Shipping Method
      operationId: list_shipping_methods
      summary: List a site's shipping methods
      description: See the Pagination Guide to learn how to use pagination in the API and Client Libraries.
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/ids'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/sort_dates'
      - $ref: '#/components/parameters/filter_begin_time'
      - $ref: '#/components/parameters/filter_end_time'
      responses:
        '200':
          description: A list of the site's shipping methods.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingMethodList'
        '400':
          description: Invalid or unpermitted parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples:
      - lang: Node.js
        source: "const methods = client.listShippingMethods({ params: { limit: 200 } })\n\nfor await (const method of methods.each()) {\n  console.log(method.code)\n}\n"
      - lang: Python
        source: "params = {\"limit\": 200}\nshipping_methods = client.list_shipping_methods(params=params).items()\nfor shipping_method in shipping_methods:\n    print(\"Shipping Method %s\" % shipping_method.code)\n"
      - lang: .NET
        source: "var shippingMethods = client.ListShippingMethods();\nforeach(ShippingMethod shippingMethod in shippingMethods)\n{\n    Console.WriteLine(shippingMethod.Code);\n}\n"
      - lang: Ruby
        source: "params = {\n  limit: 200\n}\nshipping_methods = @client.list_shipping_methods(\n  params: params\n)\nshipping_methods.each do |shipping_method|\n  puts \"Shipping Method: #{shipping_method.code}\"\nend\n"
      - lang: Java
        source: "ListShippingMethodsParams params = new ListShippingMethodsParams();\nparams.setLimit(200); // Pull 200 records at a time\nfinal Pager<ShippingMethod> shippingMethods = client.listShippingMethods(params);\n\nfor (ShippingMethod shippingMethod : shippingMethods) {\n    System.out.println(shippingMethod.getCode());\n}\n"
      - lang: PHP
        source: "$options = [\n  'params' => [\n    'limit' => 200\n  ]\n];\n$shipping_methods = $client->listShippingMethods($options);\n\nforeach($shipping_methods as $shipping_method) {\n  echo 'Shipping Method: ' . $shipping_method->getCode() . PHP_EOL;\n}\n"
      - lang: Go
        source: "listParams := &recurly.ListShippingMethodsParams{\n\tSort:  recurly.String(\"created_at\"),\n\tOrder: recurly.String(\"desc\"),\n\tLimit: recurly.Int(200),\n}\nshippingMethods, err := client.ListShippingMethods(listParams)\nif err != nil {\n\tfmt.Println(\"Unexpected error: %v\", err)\n\treturn\n}\n\nfor shippingMethods.HasMore() {\n\terr := shippingMethods.Fetch()\n\tif e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, method := range shippingMethods.Data() {\n\t\tfmt.Printf(\"Shipping Method %3d: %s, %s\\n\",\n\t\t\ti,\n\t\t\tmethod.Id,\n\t\t\tmethod.Code,\n\t\t)\n\t}\n}"
      x-readme:
        code-samples:
        - language: node
          code: "const methods = client.listShippingMethods({ params: { limit: 200 } })\n\nfor await (const method of methods.each()) {\n  console.log(method.code)\n}\n"
          name: Node.js
        - language: python
          code: "params = {\"limit\": 200}\nshipping_methods = client.list_shipping_methods(params=params).items()\nfor shipping_method in shipping_methods:\n    print(\"Shipping Method %s\" % shipping_method.code)\n"
          name: Python
        - language: csharp
          code: "var shippingMethods = client.ListShippingMethods();\nforeach(ShippingMethod shippingMethod in shippingMethods)\n{\n    Console.WriteLine(shippingMethod.Code);\n}\n"
          name: .NET
        - language: ruby
          code: "params = {\n  limit: 200\n}\nshipping_methods = @client.list_shipping_methods(\n  params: params\n)\nshipping_methods.each do |shipping_method|\n  puts \"Shipping Method: #{shipping_method.code}\"\nend\n"
          name: Ruby
        - language: java
          code: "ListShippingMethodsParams params = new ListShippingMethodsParams();\nparams.setLimit(200); // Pull 200 records at a time\nfinal Pager<ShippingMethod> shippingMethods = client.listShippingMethods(params);\n\nfor (ShippingMethod shippingMethod : shippingMethods) {\n    System.out.println(shippingMethod.getCode());\n}\n"
          name: Java
        - language: php
          code: "$options = [\n  'params' => [\n    'limit' => 200\n  ]\n];\n$shipping_methods = $client->listShippingMethods($options);\n\nforeach($shipping_methods as $shipping_method) {\n  echo 'Shipping Method: ' . $shipping_method->getCode() . PHP_EOL;\n}\n"
          name: PHP
        - language: go
          code: "listParams := &recurly.ListShippingMethodsParams{\n\tSort:  recurly.String(\"created_at\"),\n\tOrder: recurly.String(\"desc\"),\n\tLimit: recurly.Int(200),\n}\nshippingMethods, err := client.ListShippingMethods(listParams)\nif err != nil {\n\tfmt.Println(\"Unexpected error: %v\", err)\n\treturn\n}\n\nfor shippingMethods.HasMore() {\n\terr := shippingMethods.Fetch()\n\tif e, ok := err.(*recurly.Error); ok {\n\t\tfmt.Printf(\"Failed to retrieve next page: %v\", e)\n\t\tbreak\n\t}\n\tfor i, method := range shippingMethods.Data() {\n\t\tfmt.Printf(\"Shipping Method %3d: %s, %s\\n\",\n\t\t\ti,\n\t\t\tmethod.Id,\n\t\t\tmethod.Code,\n\t\t)\n\t}\n}"
          name: Go
    post:
      tags:
      - Shipping Method
      operationId: create_shipping_method
      summary: Create a new shipping method
      parameters:
      - $ref: '#/components/parameters/accept_header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingMethodCreate'
        required: true
      responses:
        '201':
          description: A new shipping method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingMethod'
        '400':
          description: Bad request, perhaps invalid JSON?
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
  /shipping_methods/{shipping_method_id}:
    get:
      tags:
      - Shipping Method
      operationId: get_shipping_method
      summary: Fetch a shipping method
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/shipping_method_id'
      responses:
        '200':
          description: A shipping method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingMethod'
        '404':
          description: Incorrect site or shipping method ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    put:
      tags:
      - Shipping Method
      operationId: update_shipping_method
      summary: Update an active Shipping Method
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/shipping_method_id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShippingMethodUpdate'
        required: true
      responses:
        '200':
          description: The updated shipping method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingMethod'
        '400':
          description: Bad request, perhaps invalid JSON?
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Incorrect site or shipping method ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    delete:
      tags:
      - Shipping Method
      operationId: deactivate_shipping_method
      summary: Deactivate a shipping method
      parameters:
      - $ref: '#/components/parameters/accept_header'
      - $ref: '#/components/parameters/shipping_method_id'
      description: Deactivating a shipping method makes it unavailable for new subscriptions or purchases. It will not affect existing subscriptions.
      responses:
        '200':
          description: A shipping method.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingMethod'
        '422':
          description: Shipping method may already be inactive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-code-samples: []
    servers:
    - url: https://v3.recurly.com
    - url: https://v3.eu.recurly.com
components:
  schemas:
    ShippingMethodList:
      type: object
      properties:
        object:
          type: string
          title: Object type
          description: Will always be List.
        has_more:
          type: boolean
          description: Indicates there are more results on subsequent pages.
        next:
          type: string
          description: Path to subsequent page of results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/ShippingMethod'
    AcceptHeaderEnum:
      type: string
      enum:
      - application/vnd.recurly.v2021-02-25
      - application/vnd.recurly.v2021-02-25+json
    ShippingMethodCreate:
      type: object
      properties:
        code:
          type: string
          title: Code
          description: The internal name used identify the shipping method.
          pattern: /^[a-z0-9_+-]+$/i
          maxLength: 50
        name:
          type: string
          title: Name
          description: The name of the shipping method displayed to customers.
          maxLength: 100
        accounting_code:
          type: string
          title: Accounting Code
          description: Accounting code for shipping method.
          maxLength: 20
        tax_code:
          type: string
          title: Tax code
          description: 'Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax

            code values are specific to each tax system. If you are using Recurly’s

            built-in taxes the values are:


            - `FR` – Common Carrier FOB Destination

            - `FR022000` – Common Carrier FOB Origin

            - `FR020400` – Non Common Carrier FOB Destination

            - `FR020500` – Non Common Carrier FOB Origin

            - `FR010100` – Delivery by Company Vehicle Before Passage of Title

            - `FR010200` – Delivery by Company Vehicle After Passage of Title

            - `NT` – Non-Taxable

            '
          maxLength: 50
        liability_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        revenue_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        performance_obligation_id:
          type: string
          title: Performance Obligation ID
          description: 'The ID of a performance obligation. Performance obligations are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
      required:
      - code
      - name
    Error:
      type: object
      properties:
        type:
          title: Type
          $ref: '#/components/schemas/ErrorTypeEnum'
        message:
          type: string
          title: Message
        params:
          type: array
          title: Parameter specific errors
          items:
            type: object
            properties:
              param:
                type: string
    ShippingMethod:
      type: object
      properties:
        id:
          type: string
          title: Shipping Method ID
          readOnly: true
          maxLength: 13
        object:
          type: string
          title: Object type
          readOnly: true
        code:
          type: string
          title: Code
          description: The internal name used identify the shipping method.
          maxLength: 50
        name:
          type: string
          title: Name
          description: The name of the shipping method displayed to customers.
          maxLength: 100
        accounting_code:
          type: string
          title: Accounting Code
          description: Accounting code for shipping method.
          maxLength: 20
        tax_code:
          type: string
          title: Tax code
          description: 'Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax

            code values are specific to each tax system. If you are using Recurly’s

            built-in taxes the values are:


            - `FR` – Common Carrier FOB Destination

            - `FR022000` – Common Carrier FOB Origin

            - `FR020400` – Non Common Carrier FOB Destination

            - `FR020500` – Non Common Carrier FOB Origin

            - `FR010100` – Delivery by Company Vehicle Before Passage of Title

            - `FR010200` – Delivery by Company Vehicle After Passage of Title

            - `NT` – Non-Taxable

            '
          maxLength: 50
        liability_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        revenue_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        performance_obligation_id:
          type: string
          title: Performance Obligation ID
          description: 'The ID of a performance obligation. Performance obligations are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        created_at:
          type: string
          format: date-time
          title: Created at
          readOnly: true
        updated_at:
          type: string
          format: date-time
          title: Last updated at
          readOnly: true
        deleted_at:
          type: string
          format: date-time
          title: Deleted at
          readOnly: true
    TimestampSortEnum:
      type: string
      enum:
      - created_at
      - updated_at
    AlphanumericSortEnum:
      type: string
      enum:
      - asc
      - desc
    ErrorTypeEnum:
      type: string
      enum:
      - bad_request
      - immutable_subscription
      - internal_server_error
      - invalid_api_key
      - invalid_api_version
      - invalid_content_type
      - invalid_permissions
      - invalid_token
      - missing_feature
      - not_found
      - rate_limited
      - service_not_available
      - simultaneous_request
      - tax_service_error
      - transaction
      - unauthorized
      - unavailable_in_api_version
      - unknown_api_version
      - validation
    ShippingMethodUpdate:
      type: object
      properties:
        code:
          type: string
          title: Code
          description: The internal name used identify the shipping method.
          pattern: /^[a-z0-9_+-]+$/i
          maxLength: 50
        name:
          type: string
          title: Name
          description: The name of the shipping method displayed to customers.
          maxLength: 100
        accounting_code:
          type: string
          title: Accounting Code
          description: Accounting code for shipping method.
          maxLength: 20
        tax_code:
          type: string
          title: Tax code
          description: 'Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax

            code values are specific to each tax system. If you are using Recurly’s

            built-in taxes the values are:


            - `FR` – Common Carrier FOB Destination

            - `FR022000` – Common Carrier FOB Origin

            - `FR020400` – Non Common Carrier FOB Destination

            - `FR020500` – Non Common Carrier FOB Origin

            - `FR010100` – Delivery by Company Vehicle Before Passage of Title

            - `FR010200` – Delivery by Company Vehicle After Passage of Title

            - `NT` – Non-Taxable

            '
          maxLength: 50
        liability_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        revenue_gl_account_id:
          type: string
          title: General Ledger Account ID
          description: 'The ID of a general ledger account. General ledger accounts are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
        performance_obligation_id:
          type: string
          title: Performance Obligation ID
          description: 'The ID of a performance obligation. Performance obligations are

            only accessible as a part of the Recurly RevRec Standard and

            Recurly RevRec Advanced features.

            '
          maxLength: 13
  parameters:
    filter_begin_time:
      name: begin_time
      in: query
      description: 'Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`.

        **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

        '
      schema:
        type: string
        format: date-time
    accept_header:
      name: Accept
      in: header
      description: The API version to use for this request, e.g. `application/vnd.recurly.v2021-02-25`. Requests without a versioned `Accept` header return a 406 response.
      required: true
      schema:
        default: application/vnd.recurly.v2021-02-25
        $ref: '#/components/schemas/AcceptHeaderEnum'
    ids:
      name: ids
      in: query
      description: "Filter results by their IDs. Up to 200 IDs can be passed at once using\ncommas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.\n\n**Important notes:**\n\n* The `ids` parameter cannot be used with any other ordering or filtering\n  parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)\n* Invalid or unknown IDs will be ignored, so you should check that the\n  results correspond to your request.\n* Records are returned in an arbitrary order. Since results are all\n  returned at once you can sort the records yourself.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    order:
      name: order
      in: query
      description: Sort order.
      schema:
        default: desc
        $ref: '#/components/schemas/AlphanumericSortEnum'
    shipping_method_id:
      name: shipping_method_id
      in: path
      description: Shipping Method ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-usps_2-day`.
      required: true
      schema:
        type: string
    sort_dates:
      name: sort
      in: query
      description: 'Sort field. You *really* only want to sort by `updated_at` in ascending

        order. In descending order updated records will move behind the cursor and could

        prevent some records from being returned.

        '
      schema:
        default: created_at
        $ref: '#/components/schemas/TimestampSortEnum'
    filter_end_time:
      name: end_time
      in: query
      description: 'Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`.

        **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

        '
      schema:
        type: string
        format: date-time
    limit:
      name: limit
      in: query
      description: Limit number of records 1-200.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 20
  securitySchemes:
    api_key:
      type: http
      description: Enter the API key as the username and set the password to an empty string. You can locate and manage your API keys from the [API Credentials](https://app.recurly.com/go/developer/api_keys) page.
      scheme: basic
x-refined-from:
- recurly-v3-v2021-02-25-api.yaml
- recurly-openapi.yml
x-readme:
  explorer-enabled: false