---
openapi: 3.0.3
info:
  title: Webshipper V2 REST API
  description: |2

      <p>
        The Webshipper API is a RESTful JSON API that gives full control over your Webshipper account. The API is scoped to your <em>account name</em>,
        and is accessed via the endpoint <em>https://&lt;account name&gt;.api.webshipper.io/v2/</em>. Your <em>account name</em> is the same as you see when you access the Webshipper web UI
        at <em>https://&lt;account name&gt;.webshipper.io</em>.
      </p>

      <p>
        This API conforms to the <a href="http://jsonapi.org/">JSON API standard</a> with the following conventions:
        <ul>
          <li>Resources are identified with the attribute <code>id</code>, which is a server-side generated sequential integer</li>
          <li>Resource types are pluralised and underscored, like <code>order_lines</code></li>
          <li>The API has a fixed page limit of 30 records. To fetch more records use the query parameter <code>page[number]</code></li>
          <li>All resources have the attributes <code>created_at</code> and <code>updated_at</code> which are ISO 8601 timestamps like <code>2018-03-07T14:01:18.000Z</code> </li>
          <li>All country codes are <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a> codes</li>
        </ul>
      </p>


      <p> It is also possible to download the documentation in the OpenAPI 3.0 <a href="?download_openapi=1">here</a> </p>

      <div class="alert alert-info">
        <i class="fa fa-info mr-2"></i>
        Webshipper <em>strongly</em> recommends using a client library for utilising this API. Refer to jsonapi.org's list of
        <a href="http://jsonapi.org/implementations/#client-libraries">jsonapi.org's list of client libraries</a> to find one for your language.
      </div>
  version: '1'
servers:
- url: https://{tenant}.api.webshipper.io/v2
  variables:
    tenant:
      default: ''
      description: Your webshipper account name
paths:
  "/brands/{id}":
    get:
      summary: Show a single Other
      tags:
      - Other
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - brands
                      attributes:
                        "$ref": "#/components/schemas/brands"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Other
      tags:
      - Other
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - brands
                    attributes:
                      "$ref": "#/components/schemas/brands"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - brands
                      attributes:
                        "$ref": "#/components/schemas/brands"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Other
      tags:
      - Other
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - brands
                      attributes:
                        "$ref": "#/components/schemas/brands"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/brands":
    get:
      summary: List all Others
      tags:
      - Other
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/brands"
    post:
      summary: Create a Other
      tags:
      - Other
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - brands
                    attributes:
                      "$ref": "#/components/schemas/brands"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - brands
                      attributes:
                        "$ref": "#/components/schemas/brands"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/return_refund_methods/{id}":
    get:
      summary: Show a single Other
      tags:
      - Other
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_refund_methods
                      attributes:
                        "$ref": "#/components/schemas/return_refund_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      return_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_lines"
    patch:
      summary: Update a Other
      tags:
      - Other
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - return_refund_methods
                    attributes:
                      "$ref": "#/components/schemas/return_refund_methods"
                relationships:
                  type: object
                  properties:
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
                    return_line:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_lines
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_refund_methods
                      attributes:
                        "$ref": "#/components/schemas/return_refund_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      return_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_lines"
    delete:
      summary: Delete a Other
      tags:
      - Other
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_refund_methods
                      attributes:
                        "$ref": "#/components/schemas/return_refund_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      return_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_lines"
  "/return_refund_methods":
    get:
      summary: List all Others
      tags:
      - Other
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/return_refund_methods"
    post:
      summary: Create a Other
      tags:
      - Other
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - return_refund_methods
                    attributes:
                      "$ref": "#/components/schemas/return_refund_methods"
                relationships:
                  type: object
                  properties:
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
                    return_line:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_lines
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_refund_methods
                      attributes:
                        "$ref": "#/components/schemas/return_refund_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      return_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_lines"
  "/actions/{id}":
    get:
      summary: Show a single Action
      tags:
      - Action
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - actions
                      attributes:
                        "$ref": "#/components/schemas/actions"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
    patch:
      summary: Update a Action
      tags:
      - Action
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - actions
                    attributes:
                      "$ref": "#/components/schemas/actions"
                relationships:
                  type: object
                  properties:
                    automation:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - automations
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - actions
                      attributes:
                        "$ref": "#/components/schemas/actions"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
    delete:
      summary: Delete a Action
      tags:
      - Action
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - actions
                      attributes:
                        "$ref": "#/components/schemas/actions"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
  "/actions":
    get:
      summary: List all Actions
      tags:
      - Action
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/actions"
    post:
      summary: Create a Action
      tags:
      - Action
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - actions
                    attributes:
                      "$ref": "#/components/schemas/actions"
                relationships:
                  type: object
                  properties:
                    automation:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - automations
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - actions
                      attributes:
                        "$ref": "#/components/schemas/actions"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
  "/activities/{id}":
    get:
      summary: Show a single Activity
      tags:
      - Activity
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activities
                      attributes:
                        "$ref": "#/components/schemas/activities"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      status_event_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
                          - "$ref": "#/components/schemas/models"
    patch:
      summary: Update a Activity
      tags:
      - Activity
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - activities
                    attributes:
                      "$ref": "#/components/schemas/activities"
                relationships:
                  type: object
                  properties:
                    activity_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - activity_types
                    status_event_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - activity_types
                    model:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - models
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activities
                      attributes:
                        "$ref": "#/components/schemas/activities"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      status_event_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
                          - "$ref": "#/components/schemas/models"
    delete:
      summary: Delete a Activity
      tags:
      - Activity
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activities
                      attributes:
                        "$ref": "#/components/schemas/activities"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      status_event_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
                          - "$ref": "#/components/schemas/models"
  "/activities":
    get:
      summary: List all Activitys
      tags:
      - Activity
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/activities"
    post:
      summary: Create a Activity
      tags:
      - Activity
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - activities
                    attributes:
                      "$ref": "#/components/schemas/activities"
                relationships:
                  type: object
                  properties:
                    activity_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - activity_types
                    status_event_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - activity_types
                    model:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - models
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activities
                      attributes:
                        "$ref": "#/components/schemas/activities"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      status_event_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
                          - "$ref": "#/components/schemas/models"
  "/activity_types/{id}":
    get:
      summary: Show a single Activity Types
      tags:
      - Activity Types
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activity_types
                      attributes:
                        "$ref": "#/components/schemas/activity_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Activity Types
      tags:
      - Activity Types
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - activity_types
                    attributes:
                      "$ref": "#/components/schemas/activity_types"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activity_types
                      attributes:
                        "$ref": "#/components/schemas/activity_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Activity Types
      tags:
      - Activity Types
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activity_types
                      attributes:
                        "$ref": "#/components/schemas/activity_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/activity_types":
    get:
      summary: List all Activity Typess
      tags:
      - Activity Types
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[active]
        schema:
          type: string
        in: query
        description: Filter by active
      - name: filter[model]
        schema:
          type: string
        in: query
        description: Filter by model
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/activity_types"
    post:
      summary: Create a Activity Types
      tags:
      - Activity Types
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - activity_types
                    attributes:
                      "$ref": "#/components/schemas/activity_types"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - activity_types
                      attributes:
                        "$ref": "#/components/schemas/activity_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/additional_attributes/{id}":
    get:
      summary: Show a single Additional Attribute
      tags:
      - Additional Attribute
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - additional_attributes
                      attributes:
                        "$ref": "#/components/schemas/additional_attributes"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/order_lines"
    patch:
      summary: Update a Additional Attribute
      tags:
      - Additional Attribute
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - additional_attributes
                    attributes:
                      "$ref": "#/components/schemas/additional_attributes"
                relationships:
                  type: object
                  properties:
                    order:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - orders
                    order_line:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_lines
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - additional_attributes
                      attributes:
                        "$ref": "#/components/schemas/additional_attributes"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/order_lines"
    delete:
      summary: Delete a Additional Attribute
      tags:
      - Additional Attribute
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - additional_attributes
                      attributes:
                        "$ref": "#/components/schemas/additional_attributes"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/order_lines"
  "/additional_attributes":
    get:
      summary: List all Additional Attributes
      tags:
      - Additional Attribute
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/additional_attributes"
    post:
      summary: Create a Additional Attribute
      tags:
      - Additional Attribute
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - additional_attributes
                    attributes:
                      "$ref": "#/components/schemas/additional_attributes"
                relationships:
                  type: object
                  properties:
                    order:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - orders
                    order_line:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_lines
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - additional_attributes
                      attributes:
                        "$ref": "#/components/schemas/additional_attributes"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/order_lines"
  "/attachments/{id}":
    get:
      summary: Show a single Attachment
      tags:
      - Attachment
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - attachments
                      attributes:
                        "$ref": "#/components/schemas/attachments"
                  relationships:
                    type: object
                    properties:
                      document:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - documents
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/documents"
                          - "$ref": "#/components/schemas/has_documents"
    patch:
      summary: Update a Attachment
      tags:
      - Attachment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - attachments
                    attributes:
                      "$ref": "#/components/schemas/attachments"
                relationships:
                  type: object
                  properties:
                    document:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - documents
                    has_documents:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - has_documents
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - attachments
                      attributes:
                        "$ref": "#/components/schemas/attachments"
                  relationships:
                    type: object
                    properties:
                      document:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - documents
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/documents"
                          - "$ref": "#/components/schemas/has_documents"
    delete:
      summary: Delete a Attachment
      tags:
      - Attachment
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - attachments
                      attributes:
                        "$ref": "#/components/schemas/attachments"
                  relationships:
                    type: object
                    properties:
                      document:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - documents
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/documents"
                          - "$ref": "#/components/schemas/has_documents"
  "/attachments":
    get:
      summary: List all Attachments
      tags:
      - Attachment
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/attachments"
    post:
      summary: Create a Attachment
      tags:
      - Attachment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - attachments
                    attributes:
                      "$ref": "#/components/schemas/attachments"
                relationships:
                  type: object
                  properties:
                    document:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - documents
                    has_documents:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - has_documents
            examples:
              Attaching to an Order:
                value:
                  data:
                    type: attachments
                    relationships:
                      document:
                        data:
                          type: documents
                          id: 532
                      has_documents:
                        data:
                          type: orders
                          id: 532
              Attaching to a Shipment:
                value:
                  data:
                    type: shipments
                    attributes:
                      included_documents:
                      - document_id: 1
                    relationships:
                      order:
                        data:
                          type: orders
                          id: 123
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - attachments
                      attributes:
                        "$ref": "#/components/schemas/attachments"
                  relationships:
                    type: object
                    properties:
                      document:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - documents
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/documents"
                          - "$ref": "#/components/schemas/has_documents"
  "/automations/{id}":
    get:
      summary: Show a single Automation
      tags:
      - Automation
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations
                      attributes:
                        "$ref": "#/components/schemas/automations"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
    patch:
      summary: Update a Automation
      tags:
      - Automation
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - automations
                    attributes:
                      "$ref": "#/components/schemas/automations"
                relationships:
                  type: object
                  properties:
                    activity_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - activity_types
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations
                      attributes:
                        "$ref": "#/components/schemas/automations"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
    delete:
      summary: Delete a Automation
      tags:
      - Automation
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations
                      attributes:
                        "$ref": "#/components/schemas/automations"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
  "/automations":
    get:
      summary: List all Automations
      tags:
      - Automation
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/automations"
    post:
      summary: Create a Automation
      tags:
      - Automation
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - automations
                    attributes:
                      "$ref": "#/components/schemas/automations"
                relationships:
                  type: object
                  properties:
                    activity_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - activity_types
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations
                      attributes:
                        "$ref": "#/components/schemas/automations"
                  relationships:
                    type: object
                    properties:
                      activity_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - activity_types
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/activity_types"
  "/automations_dry_runs/{id}":
    get:
      summary: Show a single Automations Dry Run
      tags:
      - Automations Dry Run
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations_dry_runs
                      attributes:
                        "$ref": "#/components/schemas/automations_dry_runs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Automations Dry Run
      tags:
      - Automations Dry Run
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - automations_dry_runs
                    attributes:
                      "$ref": "#/components/schemas/automations_dry_runs"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations_dry_runs
                      attributes:
                        "$ref": "#/components/schemas/automations_dry_runs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Automations Dry Run
      tags:
      - Automations Dry Run
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations_dry_runs
                      attributes:
                        "$ref": "#/components/schemas/automations_dry_runs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/automations_dry_runs":
    get:
      summary: List all Automations Dry Runs
      tags:
      - Automations Dry Run
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/automations_dry_runs"
    post:
      summary: Create a Automations Dry Run
      tags:
      - Automations Dry Run
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - automations_dry_runs
                    attributes:
                      "$ref": "#/components/schemas/automations_dry_runs"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - automations_dry_runs
                      attributes:
                        "$ref": "#/components/schemas/automations_dry_runs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/barcode_ranges/{id}":
    get:
      summary: Show a single Barcode Range
      tags:
      - Barcode Range
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - barcode_ranges
                      attributes:
                        "$ref": "#/components/schemas/barcode_ranges"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
    patch:
      summary: Update a Barcode Range
      tags:
      - Barcode Range
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - barcode_ranges
                    attributes:
                      "$ref": "#/components/schemas/barcode_ranges"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - barcode_ranges
                      attributes:
                        "$ref": "#/components/schemas/barcode_ranges"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
    delete:
      summary: Delete a Barcode Range
      tags:
      - Barcode Range
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - barcode_ranges
                      attributes:
                        "$ref": "#/components/schemas/barcode_ranges"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
  "/barcode_ranges":
    get:
      summary: List all Barcode Ranges
      tags:
      - Barcode Range
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/barcode_ranges"
    post:
      summary: Create a Barcode Range
      tags:
      - Barcode Range
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - barcode_ranges
                    attributes:
                      "$ref": "#/components/schemas/barcode_ranges"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - barcode_ranges
                      attributes:
                        "$ref": "#/components/schemas/barcode_ranges"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
  "/bulk_import_orders/{id}":
    get:
      summary: Show a single Bulk import orders
      tags:
      - Bulk import orders
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_import_orders
                      attributes:
                        "$ref": "#/components/schemas/bulk_import_orders"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Bulk import orders
      tags:
      - Bulk import orders
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - bulk_import_orders
                    attributes:
                      "$ref": "#/components/schemas/bulk_import_orders"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_import_orders
                      attributes:
                        "$ref": "#/components/schemas/bulk_import_orders"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Bulk import orders
      tags:
      - Bulk import orders
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_import_orders
                      attributes:
                        "$ref": "#/components/schemas/bulk_import_orders"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/bulk_import_orders":
    get:
      summary: List all Bulk import orderss
      tags:
      - Bulk import orders
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/bulk_import_orders"
    post:
      summary: Create a Bulk import orders
      tags:
      - Bulk import orders
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - bulk_import_orders
                    attributes:
                      "$ref": "#/components/schemas/bulk_import_orders"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_import_orders
                      attributes:
                        "$ref": "#/components/schemas/bulk_import_orders"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/csv_mappings/{id}":
    get:
      summary: Show a single CSV Mapping
      tags:
      - CSV Mapping
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_mappings
                      attributes:
                        "$ref": "#/components/schemas/csv_mappings"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
    patch:
      summary: Update a CSV Mapping
      tags:
      - CSV Mapping
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - csv_mappings
                    attributes:
                      "$ref": "#/components/schemas/csv_mappings"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_mappings
                      attributes:
                        "$ref": "#/components/schemas/csv_mappings"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
    delete:
      summary: Delete a CSV Mapping
      tags:
      - CSV Mapping
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_mappings
                      attributes:
                        "$ref": "#/components/schemas/csv_mappings"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
  "/csv_mappings":
    get:
      summary: List all CSV Mappings
      tags:
      - CSV Mapping
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/csv_mappings"
    post:
      summary: Create a CSV Mapping
      tags:
      - CSV Mapping
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - csv_mappings
                    attributes:
                      "$ref": "#/components/schemas/csv_mappings"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_mappings
                      attributes:
                        "$ref": "#/components/schemas/csv_mappings"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
  "/csv_rules/{id}":
    get:
      summary: Show a single CSV Mapping Rule
      tags:
      - CSV Mapping Rule
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_rules
                      attributes:
                        "$ref": "#/components/schemas/csv_rules"
                  relationships:
                    type: object
                    properties:
                      mapping:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - csv_mappings
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/csv_mappings"
    patch:
      summary: Update a CSV Mapping Rule
      tags:
      - CSV Mapping Rule
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - csv_rules
                    attributes:
                      "$ref": "#/components/schemas/csv_rules"
                relationships:
                  type: object
                  properties:
                    mapping:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - csv_mappings
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_rules
                      attributes:
                        "$ref": "#/components/schemas/csv_rules"
                  relationships:
                    type: object
                    properties:
                      mapping:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - csv_mappings
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/csv_mappings"
    delete:
      summary: Delete a CSV Mapping Rule
      tags:
      - CSV Mapping Rule
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_rules
                      attributes:
                        "$ref": "#/components/schemas/csv_rules"
                  relationships:
                    type: object
                    properties:
                      mapping:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - csv_mappings
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/csv_mappings"
  "/csv_rules":
    get:
      summary: List all CSV Mapping Rules
      tags:
      - CSV Mapping Rule
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/csv_rules"
    post:
      summary: Create a CSV Mapping Rule
      tags:
      - CSV Mapping Rule
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - csv_rules
                    attributes:
                      "$ref": "#/components/schemas/csv_rules"
                relationships:
                  type: object
                  properties:
                    mapping:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - csv_mappings
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_rules
                      attributes:
                        "$ref": "#/components/schemas/csv_rules"
                  relationships:
                    type: object
                    properties:
                      mapping:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - csv_mappings
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/csv_mappings"
  "/csv_uploads":
    post:
      summary: Create a CSV Upload
      tags:
      - CSV Upload
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - csv_uploads
                    attributes:
                      "$ref": "#/components/schemas/csv_uploads"
                relationships:
                  type: object
                  properties:
                    mapping:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - csv_mappings
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - csv_uploads
                      attributes:
                        "$ref": "#/components/schemas/csv_uploads"
                  relationships:
                    type: object
                    properties:
                      mapping:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - csv_mappings
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/csv_mappings"
  "/carriers/{id}":
    get:
      summary: Show a single Carrier
      tags:
      - Carrier
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carriers
                      attributes:
                        "$ref": "#/components/schemas/carriers"
                  relationships:
                    type: object
                    properties:
                      carrier_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carrier_types
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carrier_types"
                          - "$ref": "#/components/schemas/shipping_addresses"
    patch:
      summary: Update a Carrier
      tags:
      - Carrier
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - carriers
                    attributes:
                      "$ref": "#/components/schemas/carriers"
                relationships:
                  type: object
                  properties:
                    carrier_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carrier_types
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carriers
                      attributes:
                        "$ref": "#/components/schemas/carriers"
                  relationships:
                    type: object
                    properties:
                      carrier_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carrier_types
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carrier_types"
                          - "$ref": "#/components/schemas/shipping_addresses"
    delete:
      summary: Delete a Carrier
      tags:
      - Carrier
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carriers
                      attributes:
                        "$ref": "#/components/schemas/carriers"
                  relationships:
                    type: object
                    properties:
                      carrier_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carrier_types
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carrier_types"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/carriers":
    get:
      summary: List all Carriers
      tags:
      - Carrier
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[billable]
        schema:
          type: string
        in: query
        description: Filter by billable
      - name: filter[carrier_type_codes]
        schema:
          type: string
        in: query
        description: Filter by carrier_type_codes
      - name: filter[carrier_group_id]
        schema:
          type: string
        in: query
        description: Filter by carrier_group_id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/carriers"
    post:
      summary: Create a Carrier
      tags:
      - Carrier
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - carriers
                    attributes:
                      "$ref": "#/components/schemas/carriers"
                relationships:
                  type: object
                  properties:
                    carrier_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carrier_types
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carriers
                      attributes:
                        "$ref": "#/components/schemas/carriers"
                  relationships:
                    type: object
                    properties:
                      carrier_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carrier_types
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carrier_types"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/carrier_accesses/{id}":
    get:
      summary: Show a single Carrier Access
      tags:
      - Carrier Access
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carrier_accesses
                      attributes:
                        "$ref": "#/components/schemas/carrier_accesses"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/users"
    delete:
      summary: Delete a Carrier Access
      tags:
      - Carrier Access
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carrier_accesses
                      attributes:
                        "$ref": "#/components/schemas/carrier_accesses"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/users"
  "/carrier_accesses":
    get:
      summary: List all Carrier Accesss
      tags:
      - Carrier Access
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/carrier_accesses"
    post:
      summary: Create a Carrier Access
      tags:
      - Carrier Access
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - carrier_accesses
                    attributes:
                      "$ref": "#/components/schemas/carrier_accesses"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carrier_accesses
                      attributes:
                        "$ref": "#/components/schemas/carrier_accesses"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/users"
  "/carrier_types/{id}":
    get:
      summary: Show a single Carrier Type
      tags:
      - Carrier Type
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - carrier_types
                      attributes:
                        "$ref": "#/components/schemas/carrier_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/carrier_types":
    get:
      summary: List all Carrier Types
      tags:
      - Carrier Type
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[carrier_code]
        schema:
          type: string
        in: query
        description: Filter by carrier_code
      - name: filter[carrier_group_id]
        schema:
          type: string
        in: query
        description: Filter by carrier_group_id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/carrier_types"
  "/comments/{id}":
    get:
      summary: Show a single Comment
      tags:
      - Comment
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - comments
                      attributes:
                        "$ref": "#/components/schemas/comments"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/models"
    patch:
      summary: Update a Comment
      tags:
      - Comment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - comments
                    attributes:
                      "$ref": "#/components/schemas/comments"
                relationships:
                  type: object
                  properties:
                    model:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - models
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - comments
                      attributes:
                        "$ref": "#/components/schemas/comments"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/models"
    delete:
      summary: Delete a Comment
      tags:
      - Comment
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - comments
                      attributes:
                        "$ref": "#/components/schemas/comments"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/models"
  "/comments":
    get:
      summary: List all Comments
      tags:
      - Comment
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/comments"
    post:
      summary: Create a Comment
      tags:
      - Comment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - comments
                    attributes:
                      "$ref": "#/components/schemas/comments"
                relationships:
                  type: object
                  properties:
                    model:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - models
            examples:
              Create a comment:
                value:
                  data:
                    type: comments
                    attributes:
                      comment: This is a comment
                      initiator: John Doe
                      comment_type: internal_comment
                  relationships:
                    order:
                      data:
                        id: 123456
                        type: orders
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - comments
                      attributes:
                        "$ref": "#/components/schemas/comments"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/models"
  "/customs_lines/{id}":
    get:
      summary: Show a single Customs Line
      tags:
      - Customs Line
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - customs_lines
                      attributes:
                        "$ref": "#/components/schemas/customs_lines"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Customs Line
      tags:
      - Customs Line
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - customs_lines
                    attributes:
                      "$ref": "#/components/schemas/customs_lines"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - customs_lines
                      attributes:
                        "$ref": "#/components/schemas/customs_lines"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Customs Line
      tags:
      - Customs Line
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - customs_lines
                      attributes:
                        "$ref": "#/components/schemas/customs_lines"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/customs_lines":
    get:
      summary: List all Customs Lines
      tags:
      - Customs Line
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/customs_lines"
    post:
      summary: Create a Customs Line
      tags:
      - Customs Line
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - customs_lines
                    attributes:
                      "$ref": "#/components/schemas/customs_lines"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - customs_lines
                      attributes:
                        "$ref": "#/components/schemas/customs_lines"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/documents/{id}":
    get:
      summary: Show a single Document
      tags:
      - Document
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - documents
                      attributes:
                        "$ref": "#/components/schemas/documents"
                  relationships:
                    type: object
                    properties:
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/has_documents"
    patch:
      summary: Update a Document
      tags:
      - Document
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - documents
                    attributes:
                      "$ref": "#/components/schemas/documents"
                relationships:
                  type: object
                  properties:
                    has_documents:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - has_documents
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - documents
                      attributes:
                        "$ref": "#/components/schemas/documents"
                  relationships:
                    type: object
                    properties:
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/has_documents"
    delete:
      summary: Delete a Document
      tags:
      - Document
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - documents
                      attributes:
                        "$ref": "#/components/schemas/documents"
                  relationships:
                    type: object
                    properties:
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/has_documents"
  "/documents":
    get:
      summary: List all Documents
      tags:
      - Document
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[is_special]
        schema:
          type: string
        in: query
        description: Filter by is_special
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/documents"
    post:
      summary: Create a Document
      tags:
      - Document
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - documents
                    attributes:
                      "$ref": "#/components/schemas/documents"
                relationships:
                  type: object
                  properties:
                    has_documents:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - has_documents
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - documents
                      attributes:
                        "$ref": "#/components/schemas/documents"
                  relationships:
                    type: object
                    properties:
                      has_documents:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - has_documents
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/has_documents"
  "/document_templates/{id}":
    get:
      summary: Show a single Document Templates
      tags:
      - Document Templates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - document_templates
                      attributes:
                        "$ref": "#/components/schemas/document_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Document Templates
      tags:
      - Document Templates
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - document_templates
                    attributes:
                      "$ref": "#/components/schemas/document_templates"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - document_templates
                      attributes:
                        "$ref": "#/components/schemas/document_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Document Templates
      tags:
      - Document Templates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - document_templates
                      attributes:
                        "$ref": "#/components/schemas/document_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/document_templates":
    get:
      summary: List all Document Templatess
      tags:
      - Document Templates
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[document_type]
        schema:
          type: string
        in: query
        description: Filter by document_type
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/document_templates"
    post:
      summary: Create a Document Templates
      tags:
      - Document Templates
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - document_templates
                    attributes:
                      "$ref": "#/components/schemas/document_templates"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - document_templates
                      attributes:
                        "$ref": "#/components/schemas/document_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/drop_point_locators":
    post:
      summary: Search for drop points
      tags:
      - Drop Point Locator
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - drop_point_locators
                    attributes:
                      "$ref": "#/components/schemas/drop_point_locators"
                relationships:
                  type: object
                  properties: {}
            examples:
              Query droppoints near address by carrier and service code:
                value:
                  data:
                    type: drop_point_locators
                    attributes:
                      carrier_id: 1
                      service_code: PARCELSHOP
                      delivery_address:
                        address_1: Lyngbygade 8
                        zip: '8600'
                        city: Silkeborg
                        country_code: DK
              Query droppoints near address by shipping rate ID:
                value:
                  data:
                    type: drop_point_locators
                    attributes:
                      shipping_rate_id: 1
                      delivery_address:
                        address_1: Lyngbygade 8
                        zip: '8600'
                        city: Silkeborg
                        country_code: DK
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - drop_point_locators
                      attributes:
                        "$ref": "#/components/schemas/drop_point_locators"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/edis/{id}":
    get:
      summary: Show a single EDI
      tags:
      - EDI
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - edis
                      attributes:
                        "$ref": "#/components/schemas/edis"
                  relationships:
                    type: object
                    properties:
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipments"
  "/edis":
    get:
      summary: List all EDIs
      tags:
      - EDI
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[shipment_id]
        schema:
          type: string
        in: query
        description: Filter by shipment_id
      - name: filter[waybill_id]
        schema:
          type: string
        in: query
        description: Filter by waybill_id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/edis"
  "/end_of_day_reports/{id}":
    get:
      summary: Show a single End-of-day report
      tags:
      - End-of-day report
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - end_of_day_reports
                      attributes:
                        "$ref": "#/components/schemas/end_of_day_reports"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
    patch:
      summary: Update a End-of-day report
      tags:
      - End-of-day report
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - end_of_day_reports
                    attributes:
                      "$ref": "#/components/schemas/end_of_day_reports"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - end_of_day_reports
                      attributes:
                        "$ref": "#/components/schemas/end_of_day_reports"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
    delete:
      summary: Delete a End-of-day report
      tags:
      - End-of-day report
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - end_of_day_reports
                      attributes:
                        "$ref": "#/components/schemas/end_of_day_reports"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
  "/end_of_day_reports":
    get:
      summary: List all End-of-day reports
      tags:
      - End-of-day report
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/end_of_day_reports"
    post:
      summary: Create a End-of-day report
      tags:
      - End-of-day report
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - end_of_day_reports
                    attributes:
                      "$ref": "#/components/schemas/end_of_day_reports"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - end_of_day_reports
                      attributes:
                        "$ref": "#/components/schemas/end_of_day_reports"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
  "/error_types/{id}":
    get:
      summary: Show a single Error Type
      tags:
      - Error Type
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - error_types
                      attributes:
                        "$ref": "#/components/schemas/error_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Error Type
      tags:
      - Error Type
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - error_types
                    attributes:
                      "$ref": "#/components/schemas/error_types"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - error_types
                      attributes:
                        "$ref": "#/components/schemas/error_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Error Type
      tags:
      - Error Type
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - error_types
                      attributes:
                        "$ref": "#/components/schemas/error_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/error_types":
    get:
      summary: List all Error Types
      tags:
      - Error Type
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/error_types"
    post:
      summary: Create a Error Type
      tags:
      - Error Type
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - error_types
                    attributes:
                      "$ref": "#/components/schemas/error_types"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - error_types
                      attributes:
                        "$ref": "#/components/schemas/error_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/events/{id}":
    get:
      summary: Show a single Event
      tags:
      - Event
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - events
                      attributes:
                        "$ref": "#/components/schemas/events"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - event_models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/event_models"
    patch:
      summary: Update a Event
      tags:
      - Event
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - events
                    attributes:
                      "$ref": "#/components/schemas/events"
                relationships:
                  type: object
                  properties:
                    model:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - event_models
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - events
                      attributes:
                        "$ref": "#/components/schemas/events"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - event_models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/event_models"
    delete:
      summary: Delete a Event
      tags:
      - Event
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - events
                      attributes:
                        "$ref": "#/components/schemas/events"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - event_models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/event_models"
  "/events":
    get:
      summary: List all Events
      tags:
      - Event
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/events"
    post:
      summary: Create a Event
      tags:
      - Event
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - events
                    attributes:
                      "$ref": "#/components/schemas/events"
                relationships:
                  type: object
                  properties:
                    model:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - event_models
            examples:
              Adding event to order:
                value:
                  data:
                    type: events
                    attributes:
                      title: Unable to capture order
                      details: Log reference 12333-34-23-342
                      icon: exclamation
                    relationships:
                      model:
                        data:
                          type: orders
                          id: 100
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - events
                      attributes:
                        "$ref": "#/components/schemas/events"
                  relationships:
                    type: object
                    properties:
                      model:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - event_models
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/event_models"
  "/event_models/{id}":
    get:
      summary: Show a single EventModel
      tags:
      - EventModel
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - event_models
                      attributes:
                        "$ref": "#/components/schemas/event_models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a EventModel
      tags:
      - EventModel
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - event_models
                    attributes:
                      "$ref": "#/components/schemas/event_models"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - event_models
                      attributes:
                        "$ref": "#/components/schemas/event_models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a EventModel
      tags:
      - EventModel
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - event_models
                      attributes:
                        "$ref": "#/components/schemas/event_models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/event_models":
    get:
      summary: List all EventModels
      tags:
      - EventModel
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/event_models"
    post:
      summary: Create a EventModel
      tags:
      - EventModel
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - event_models
                    attributes:
                      "$ref": "#/components/schemas/event_models"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - event_models
                      attributes:
                        "$ref": "#/components/schemas/event_models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/favourite_pages/{id}":
    get:
      summary: Show a single Favourite Page
      tags:
      - Favourite Page
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - favourite_pages
                      attributes:
                        "$ref": "#/components/schemas/favourite_pages"
                  relationships:
                    type: object
                    properties:
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                      hot_key:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - hot_keys
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/users"
                          - "$ref": "#/components/schemas/hot_keys"
    patch:
      summary: Update a Favourite Page
      tags:
      - Favourite Page
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - favourite_pages
                    attributes:
                      "$ref": "#/components/schemas/favourite_pages"
                relationships:
                  type: object
                  properties:
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
                    hot_key:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - hot_keys
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - favourite_pages
                      attributes:
                        "$ref": "#/components/schemas/favourite_pages"
                  relationships:
                    type: object
                    properties:
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                      hot_key:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - hot_keys
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/users"
                          - "$ref": "#/components/schemas/hot_keys"
    delete:
      summary: Delete a Favourite Page
      tags:
      - Favourite Page
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - favourite_pages
                      attributes:
                        "$ref": "#/components/schemas/favourite_pages"
                  relationships:
                    type: object
                    properties:
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                      hot_key:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - hot_keys
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/users"
                          - "$ref": "#/components/schemas/hot_keys"
  "/favourite_pages":
    get:
      summary: List all Favourite Pages
      tags:
      - Favourite Page
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[user_id]
        schema:
          type: string
        in: query
        description: Filter by user_id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/favourite_pages"
    post:
      summary: Create a Favourite Page
      tags:
      - Favourite Page
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - favourite_pages
                    attributes:
                      "$ref": "#/components/schemas/favourite_pages"
                relationships:
                  type: object
                  properties:
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
                    hot_key:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - hot_keys
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - favourite_pages
                      attributes:
                        "$ref": "#/components/schemas/favourite_pages"
                  relationships:
                    type: object
                    properties:
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                      hot_key:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - hot_keys
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/users"
                          - "$ref": "#/components/schemas/hot_keys"
  "/has_documents/{id}":
    get:
      summary: Show a single Has Documents
      tags:
      - Has Documents
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - has_documents
                      attributes:
                        "$ref": "#/components/schemas/has_documents"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Has Documents
      tags:
      - Has Documents
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - has_documents
                    attributes:
                      "$ref": "#/components/schemas/has_documents"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - has_documents
                      attributes:
                        "$ref": "#/components/schemas/has_documents"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Has Documents
      tags:
      - Has Documents
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - has_documents
                      attributes:
                        "$ref": "#/components/schemas/has_documents"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/has_documents":
    get:
      summary: List all Has Documentss
      tags:
      - Has Documents
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/has_documents"
    post:
      summary: Create a Has Documents
      tags:
      - Has Documents
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - has_documents
                    attributes:
                      "$ref": "#/components/schemas/has_documents"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - has_documents
                      attributes:
                        "$ref": "#/components/schemas/has_documents"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/hot_keys/{id}":
    get:
      summary: Show a single HotKey
      tags:
      - HotKey
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - hot_keys
                      attributes:
                        "$ref": "#/components/schemas/hot_keys"
                  relationships:
                    type: object
                    properties:
                      favourite_page:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - favourite_pages
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/favourite_pages"
                          - "$ref": "#/components/schemas/users"
    patch:
      summary: Update a HotKey
      tags:
      - HotKey
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - hot_keys
                    attributes:
                      "$ref": "#/components/schemas/hot_keys"
                relationships:
                  type: object
                  properties:
                    favourite_page:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - favourite_pages
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - hot_keys
                      attributes:
                        "$ref": "#/components/schemas/hot_keys"
                  relationships:
                    type: object
                    properties:
                      favourite_page:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - favourite_pages
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/favourite_pages"
                          - "$ref": "#/components/schemas/users"
    delete:
      summary: Delete a HotKey
      tags:
      - HotKey
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - hot_keys
                      attributes:
                        "$ref": "#/components/schemas/hot_keys"
                  relationships:
                    type: object
                    properties:
                      favourite_page:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - favourite_pages
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/favourite_pages"
                          - "$ref": "#/components/schemas/users"
  "/hot_keys":
    get:
      summary: List all HotKeys
      tags:
      - HotKey
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/hot_keys"
    post:
      summary: Create a HotKey
      tags:
      - HotKey
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - hot_keys
                    attributes:
                      "$ref": "#/components/schemas/hot_keys"
                relationships:
                  type: object
                  properties:
                    favourite_page:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - favourite_pages
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - hot_keys
                      attributes:
                        "$ref": "#/components/schemas/hot_keys"
                  relationships:
                    type: object
                    properties:
                      favourite_page:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - favourite_pages
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/favourite_pages"
                          - "$ref": "#/components/schemas/users"
  "/labels/{id}":
    get:
      summary: Show a single Label
      tags:
      - Label
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - labels
                      attributes:
                        "$ref": "#/components/schemas/labels"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/labels":
    get:
      summary: List all Labels
      tags:
      - Label
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/labels"
  "/local_attrs/{id}":
    get:
      summary: Show a single Local Attribute
      tags:
      - Local Attribute
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - local_attrs
                      attributes:
                        "$ref": "#/components/schemas/local_attrs"
                  relationships:
                    type: object
                    properties:
                      order_channel_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channel_types
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channel_types"
  "/local_attrs":
    get:
      summary: List all Local Attributes
      tags:
      - Local Attribute
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/local_attrs"
  "/local_attr_enums/{id}":
    get:
      summary: Show a single Local Attribute Enums
      tags:
      - Local Attribute Enums
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - local_attr_enums
                      attributes:
                        "$ref": "#/components/schemas/local_attr_enums"
                  relationships:
                    type: object
                    properties:
                      local_attr:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - local_attrs
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/local_attrs"
  "/local_attr_enums":
    get:
      summary: List all Local Attribute Enumss
      tags:
      - Local Attribute Enums
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/local_attr_enums"
  "/mail_template_previews/{id}":
    get:
      summary: Show a single Mail Template Preview
      tags:
      - Mail Template Preview
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_template_previews
                      attributes:
                        "$ref": "#/components/schemas/mail_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Mail Template Preview
      tags:
      - Mail Template Preview
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - mail_template_previews
                    attributes:
                      "$ref": "#/components/schemas/mail_template_previews"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_template_previews
                      attributes:
                        "$ref": "#/components/schemas/mail_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Mail Template Preview
      tags:
      - Mail Template Preview
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_template_previews
                      attributes:
                        "$ref": "#/components/schemas/mail_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/mail_template_previews":
    get:
      summary: List all Mail Template Previews
      tags:
      - Mail Template Preview
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/mail_template_previews"
    post:
      summary: Create a Mail Template Preview
      tags:
      - Mail Template Preview
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - mail_template_previews
                    attributes:
                      "$ref": "#/components/schemas/mail_template_previews"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_template_previews
                      attributes:
                        "$ref": "#/components/schemas/mail_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/mail_templates/{id}":
    get:
      summary: Show a single Mail Templates
      tags:
      - Mail Templates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_templates
                      attributes:
                        "$ref": "#/components/schemas/mail_templates"
                  relationships:
                    type: object
                    properties:
                      brand:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - brands
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/brands"
    patch:
      summary: Update a Mail Templates
      tags:
      - Mail Templates
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - mail_templates
                    attributes:
                      "$ref": "#/components/schemas/mail_templates"
                relationships:
                  type: object
                  properties:
                    brand:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - brands
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_templates
                      attributes:
                        "$ref": "#/components/schemas/mail_templates"
                  relationships:
                    type: object
                    properties:
                      brand:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - brands
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/brands"
    delete:
      summary: Delete a Mail Templates
      tags:
      - Mail Templates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_templates
                      attributes:
                        "$ref": "#/components/schemas/mail_templates"
                  relationships:
                    type: object
                    properties:
                      brand:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - brands
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/brands"
  "/mail_templates":
    get:
      summary: List all Mail Templatess
      tags:
      - Mail Templates
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[purpose]
        schema:
          type: string
        in: query
        description: Filter by purpose
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/mail_templates"
    post:
      summary: Create a Mail Templates
      tags:
      - Mail Templates
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - mail_templates
                    attributes:
                      "$ref": "#/components/schemas/mail_templates"
                relationships:
                  type: object
                  properties:
                    brand:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - brands
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - mail_templates
                      attributes:
                        "$ref": "#/components/schemas/mail_templates"
                  relationships:
                    type: object
                    properties:
                      brand:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - brands
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/brands"
  "/order_merges":
    post:
      summary: Create a Merged Order
      tags:
      - Merged Order
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - order_merges
                    attributes:
                      "$ref": "#/components/schemas/order_merges"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_merges
                      attributes:
                        "$ref": "#/components/schemas/order_merges"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/pdf_merges/{id}":
    get:
      summary: Show a single Merged PDF
      tags:
      - Merged PDF
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - pdf_merges
                      attributes:
                        "$ref": "#/components/schemas/pdf_merges"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/pdf_merges":
    post:
      summary: Create a Merged PDF
      tags:
      - Merged PDF
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - pdf_merges
                    attributes:
                      "$ref": "#/components/schemas/pdf_merges"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - pdf_merges
                      attributes:
                        "$ref": "#/components/schemas/pdf_merges"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/models/{id}":
    get:
      summary: Show a single Model
      tags:
      - Model
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - models
                      attributes:
                        "$ref": "#/components/schemas/models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Model
      tags:
      - Model
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - models
                    attributes:
                      "$ref": "#/components/schemas/models"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - models
                      attributes:
                        "$ref": "#/components/schemas/models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Model
      tags:
      - Model
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - models
                      attributes:
                        "$ref": "#/components/schemas/models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/models":
    get:
      summary: List all Models
      tags:
      - Model
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/models"
    post:
      summary: Create a Model
      tags:
      - Model
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - models
                    attributes:
                      "$ref": "#/components/schemas/models"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - models
                      attributes:
                        "$ref": "#/components/schemas/models"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/oauth_access_tokens/{id}":
    get:
      summary: Show a single OAuth Access Token
      tags:
      - OAuth Access Token
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - oauth_access_tokens
                      attributes:
                        "$ref": "#/components/schemas/oauth_access_tokens"
                  relationships:
                    type: object
                    properties:
                      application:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - oauth_applications
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/oauth_applications"
  "/oauth_access_tokens":
    get:
      summary: List all OAuth Access Tokens
      tags:
      - OAuth Access Token
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/oauth_access_tokens"
  "/oauth_applications/{id}":
    get:
      summary: Show a single OAuth Application
      tags:
      - OAuth Application
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - oauth_applications
                      attributes:
                        "$ref": "#/components/schemas/oauth_applications"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/oauth_applications":
    get:
      summary: List all OAuth Applications
      tags:
      - OAuth Application
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[uid]
        schema:
          type: string
        in: query
        description: Filter by uid
      - name: filter[active]
        schema:
          type: string
        in: query
        description: Filter by active
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/oauth_applications"
  "/orders/{id}":
    get:
      summary: Show a single Order
      tags:
      - Order
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - orders
                      attributes:
                        "$ref": "#/components/schemas/orders"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      error_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - error_types
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/error_types"
                          - "$ref": "#/components/schemas/printer_clients"
    patch:
      summary: Update a Order
      tags:
      - Order
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - orders
                    attributes:
                      "$ref": "#/components/schemas/orders"
                relationships:
                  type: object
                  properties:
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    error_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - error_types
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - orders
                      attributes:
                        "$ref": "#/components/schemas/orders"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      error_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - error_types
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/error_types"
                          - "$ref": "#/components/schemas/printer_clients"
    delete:
      summary: Delete a Order
      tags:
      - Order
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - orders
                      attributes:
                        "$ref": "#/components/schemas/orders"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      error_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - error_types
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/error_types"
                          - "$ref": "#/components/schemas/printer_clients"
  "/orders":
    get:
      summary: List all Orders
      tags:
      - Order
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[ext_ref]
        schema:
          type: string
        in: query
        description: Filter by ext_ref
      - name: filter[sorting_id]
        schema:
          type: string
        in: query
        description: Filter by sorting_id
      - name: filter[created_at]
        schema:
          type: string
        in: query
        description: Filter by created_at
      - name: filter[updated_at]
        schema:
          type: string
        in: query
        description: Filter by updated_at
      - name: filter[status]
        schema:
          type: string
        in: query
        description: Filter by status
      - name: filter[slip_printed]
        schema:
          type: string
        in: query
        description: Filter by slip_printed
      - name: filter[label_printed]
        schema:
          type: string
        in: query
        description: Filter by label_printed
      - name: filter[visible_ref]
        schema:
          type: string
        in: query
        description: Filter by visible_ref
      - name: filter[lock_state]
        schema:
          type: string
        in: query
        description: Filter by lock_state
      - name: filter[order_channel]
        schema:
          type: string
        in: query
        description: Filter by order_channel
      - name: filter[order_channel_id]
        schema:
          type: string
        in: query
        description: Filter by order_channel_id
      - name: filter[shipping_rate]
        schema:
          type: string
        in: query
        description: Filter by shipping_rate
      - name: filter[shipping_rate_id]
        schema:
          type: string
        in: query
        description: Filter by shipping_rate_id
      - name: filter[carrier]
        schema:
          type: string
        in: query
        description: Filter by carrier
      - name: filter[sku]
        schema:
          type: string
        in: query
        description: Filter by sku
      - name: filter[free_text]
        schema:
          type: string
        in: query
        description: Filter by free_text
      - name: filter[tag]
        schema:
          type: string
        in: query
        description: Filter by tag
      - name: filter[delivery_country_code]
        schema:
          type: string
        in: query
        description: Filter by delivery_country_code
      - name: filter[activity_type]
        schema:
          type: string
        in: query
        description: Filter by activity_type
      - name: filter[order_lines]
        schema:
          type: string
        in: query
        description: Filter by order_lines
      - name: filter[billing_contact]
        schema:
          type: string
        in: query
        description: Filter by billing_contact
      - name: filter[billing_company]
        schema:
          type: string
        in: query
        description: Filter by billing_company
      - name: filter[billing_email]
        schema:
          type: string
        in: query
        description: Filter by billing_email
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/orders"
    post:
      summary: Create a Order
      tags:
      - Order
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - orders
                    attributes:
                      "$ref": "#/components/schemas/orders"
                relationships:
                  type: object
                  properties:
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    error_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - error_types
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
            examples:
              Creating an order with a drop point:
                value:
                  data:
                    type: orders
                    attributes:
                      drop_point:
                        drop_point_id: 12
                        address_1: Street 123
                        zip: '8600'
                        city: Silkeborg
                        country_code: DK
                        carrier_code: DUMMY
                      delivery_address:
                        address_1: Lyngbygade 8
                        zip: '8600'
                        city: Silkeborg
                        country_code: DK
                      sender_address:
                        address_1: Example street 2
                        zip: '7400'
                        city: Herning
                        country_code: DK
                      order_lines:
                      - sku: ZB420
                        description: Zebra GK420d label printer
                        quantity: 1
                        location: LOC 3563-67
                        tarif_number: '844332'
                        country_of_origin: DK
                        unit_price: 24.0
                        vat_percent: 25.0
                        order_id: 12
                        ext_ref: '342342'
                        weight: 500.0
                        weight_unit: g
                        discount_value: 0.0
                        discount_type: fixed
                        discounted_unit_price: 24.0
                    relationships:
                      order_channel:
                        data:
                          id: 9
                          type: order_channels
                      shipping_rate:
                        data:
                          id: 6
                          type: shipping_rates
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - orders
                      attributes:
                        "$ref": "#/components/schemas/orders"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      error_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - error_types
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/error_types"
                          - "$ref": "#/components/schemas/printer_clients"
  "/order_channels/{id}":
    get:
      summary: Show a single Order Channel
      tags:
      - Order Channel
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channels
                      attributes:
                        "$ref": "#/components/schemas/order_channels"
                  relationships:
                    type: object
                    properties:
                      order_channel_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channel_types
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      default_printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channel_types"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/printer_clients"
    patch:
      summary: Update a Order Channel
      tags:
      - Order Channel
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - order_channels
                    attributes:
                      "$ref": "#/components/schemas/order_channels"
                relationships:
                  type: object
                  properties:
                    order_channel_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channel_types
                    slip_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - slip_templates
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    pickup_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    sold_from_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    default_printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channels
                      attributes:
                        "$ref": "#/components/schemas/order_channels"
                  relationships:
                    type: object
                    properties:
                      order_channel_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channel_types
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      default_printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channel_types"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/printer_clients"
    delete:
      summary: Delete a Order Channel
      tags:
      - Order Channel
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channels
                      attributes:
                        "$ref": "#/components/schemas/order_channels"
                  relationships:
                    type: object
                    properties:
                      order_channel_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channel_types
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      default_printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channel_types"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/printer_clients"
  "/order_channels":
    get:
      summary: List all Order Channels
      tags:
      - Order Channel
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[attr]
        schema:
          type: string
        in: query
        description: Filter by attr
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/order_channels"
    post:
      summary: Create a Order Channel
      tags:
      - Order Channel
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - order_channels
                    attributes:
                      "$ref": "#/components/schemas/order_channels"
                relationships:
                  type: object
                  properties:
                    order_channel_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channel_types
                    slip_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - slip_templates
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    pickup_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    sold_from_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    default_printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channels
                      attributes:
                        "$ref": "#/components/schemas/order_channels"
                  relationships:
                    type: object
                    properties:
                      order_channel_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channel_types
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      default_printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channel_types"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/printer_clients"
  "/order_channel_accesses/{id}":
    get:
      summary: Show a single Order Channel Access
      tags:
      - Order Channel Access
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channel_accesses
                      attributes:
                        "$ref": "#/components/schemas/order_channel_accesses"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/users"
    patch:
      summary: Update a Order Channel Access
      tags:
      - Order Channel Access
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - order_channel_accesses
                    attributes:
                      "$ref": "#/components/schemas/order_channel_accesses"
                relationships:
                  type: object
                  properties:
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channel_accesses
                      attributes:
                        "$ref": "#/components/schemas/order_channel_accesses"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/users"
    delete:
      summary: Delete a Order Channel Access
      tags:
      - Order Channel Access
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channel_accesses
                      attributes:
                        "$ref": "#/components/schemas/order_channel_accesses"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/users"
  "/order_channel_accesses":
    get:
      summary: List all Order Channel Accesss
      tags:
      - Order Channel Access
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/order_channel_accesses"
    post:
      summary: Create a Order Channel Access
      tags:
      - Order Channel Access
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - order_channel_accesses
                    attributes:
                      "$ref": "#/components/schemas/order_channel_accesses"
                relationships:
                  type: object
                  properties:
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    user:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - users
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channel_accesses
                      attributes:
                        "$ref": "#/components/schemas/order_channel_accesses"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      user:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - users
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/users"
  "/order_channel_types/{id}":
    get:
      summary: Show a single Order Channel Type
      tags:
      - Order Channel Type
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - order_channel_types
                      attributes:
                        "$ref": "#/components/schemas/order_channel_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/order_channel_types":
    get:
      summary: List all Order Channel Types
      tags:
      - Order Channel Type
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[by_name]
        schema:
          type: string
        in: query
        description: Filter by by_name
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/order_channel_types"
  "/packages/{id}":
    get:
      summary: Show a single Package
      tags:
      - Package
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - packages
                      attributes:
                        "$ref": "#/components/schemas/packages"
                  relationships:
                    type: object
                    properties:
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipments"
  "/packages":
    get:
      summary: List all Packages
      tags:
      - Package
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/packages"
    post:
      summary: Create a Package
      tags:
      - Package
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - packages
                    attributes:
                      "$ref": "#/components/schemas/packages"
                relationships:
                  type: object
                  properties:
                    shipment:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipments
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - packages
                      attributes:
                        "$ref": "#/components/schemas/packages"
                  relationships:
                    type: object
                    properties:
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipments"
  "/pickups/{id}":
    get:
      summary: Show a single Pickup
      tags:
      - Pickup
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - pickups
                      attributes:
                        "$ref": "#/components/schemas/pickups"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      shipping_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
    patch:
      summary: Update a Pickup
      tags:
      - Pickup
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - pickups
                    attributes:
                      "$ref": "#/components/schemas/pickups"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    shipping_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - pickups
                      attributes:
                        "$ref": "#/components/schemas/pickups"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      shipping_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
    delete:
      summary: Delete a Pickup
      tags:
      - Pickup
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - pickups
                      attributes:
                        "$ref": "#/components/schemas/pickups"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      shipping_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/pickups":
    get:
      summary: List all Pickups
      tags:
      - Pickup
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/pickups"
    post:
      summary: Create a Pickup
      tags:
      - Pickup
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - pickups
                    attributes:
                      "$ref": "#/components/schemas/pickups"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    shipping_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - pickups
                      attributes:
                        "$ref": "#/components/schemas/pickups"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      shipping_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/bulk_printer_jobs/{id}":
    get:
      summary: Show a single Print Bulk Slips
      tags:
      - Print Bulk Slips
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/bulk_printer_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Print Bulk Slips
      tags:
      - Print Bulk Slips
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - bulk_printer_jobs
                    attributes:
                      "$ref": "#/components/schemas/bulk_printer_jobs"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/bulk_printer_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Print Bulk Slips
      tags:
      - Print Bulk Slips
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/bulk_printer_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/bulk_printer_jobs":
    get:
      summary: List all Print Bulk Slipss
      tags:
      - Print Bulk Slips
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/bulk_printer_jobs"
    post:
      summary: Create a Print Bulk Slips
      tags:
      - Print Bulk Slips
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - bulk_printer_jobs
                    attributes:
                      "$ref": "#/components/schemas/bulk_printer_jobs"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - bulk_printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/bulk_printer_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/printables/{id}":
    get:
      summary: Show a single Printable
      tags:
      - Printable
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printables
                      attributes:
                        "$ref": "#/components/schemas/printables"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Printable
      tags:
      - Printable
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - printables
                    attributes:
                      "$ref": "#/components/schemas/printables"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printables
                      attributes:
                        "$ref": "#/components/schemas/printables"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Printable
      tags:
      - Printable
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printables
                      attributes:
                        "$ref": "#/components/schemas/printables"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/printables":
    get:
      summary: List all Printables
      tags:
      - Printable
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/printables"
    post:
      summary: Create a Printable
      tags:
      - Printable
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - printables
                    attributes:
                      "$ref": "#/components/schemas/printables"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printables
                      attributes:
                        "$ref": "#/components/schemas/printables"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/printers/{id}":
    get:
      summary: Show a single Printer
      tags:
      - Printer
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printers
                      attributes:
                        "$ref": "#/components/schemas/printers"
                  relationships:
                    type: object
                    properties:
                      client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printer_clients"
  "/printers":
    get:
      summary: List all Printers
      tags:
      - Printer
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/printers"
  "/printer_clients/{id}":
    get:
      summary: Show a single Printer Client
      tags:
      - Printer Client
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_clients
                      attributes:
                        "$ref": "#/components/schemas/printer_clients"
                  relationships:
                    type: object
                    properties:
                      label_printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      zpl_printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      document_printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      location:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printers"
                          - "$ref": "#/components/schemas/shipping_addresses"
    patch:
      summary: Update a Printer Client
      tags:
      - Printer Client
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - printer_clients
                    attributes:
                      "$ref": "#/components/schemas/printer_clients"
                relationships:
                  type: object
                  properties:
                    label_printer:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printers
                    zpl_printer:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printers
                    document_printer:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printers
                    location:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_clients
                      attributes:
                        "$ref": "#/components/schemas/printer_clients"
                  relationships:
                    type: object
                    properties:
                      label_printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      zpl_printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      document_printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      location:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printers"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/printer_clients":
    get:
      summary: List all Printer Clients
      tags:
      - Printer Client
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/printer_clients"
  "/printer_jobs/{id}":
    get:
      summary: Show a single Printer Job
      tags:
      - Printer Job
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_jobs"
                  relationships:
                    type: object
                    properties:
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                      printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      printable:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printables
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printer_clients"
                          - "$ref": "#/components/schemas/printers"
                          - "$ref": "#/components/schemas/printables"
    patch:
      summary: Update a Printer Job
      tags:
      - Printer Job
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - printer_jobs
                    attributes:
                      "$ref": "#/components/schemas/printer_jobs"
                relationships:
                  type: object
                  properties:
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
                    printer:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printers
                    printable:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printables
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_jobs"
                  relationships:
                    type: object
                    properties:
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                      printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      printable:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printables
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printer_clients"
                          - "$ref": "#/components/schemas/printers"
                          - "$ref": "#/components/schemas/printables"
    delete:
      summary: Delete a Printer Job
      tags:
      - Printer Job
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_jobs"
                  relationships:
                    type: object
                    properties:
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                      printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      printable:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printables
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printer_clients"
                          - "$ref": "#/components/schemas/printers"
                          - "$ref": "#/components/schemas/printables"
  "/printer_jobs":
    get:
      summary: List all Printer Jobs
      tags:
      - Printer Job
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[printer_client_id]
        schema:
          type: string
        in: query
        description: Filter by printer_client_id
      - name: filter[created_at]
        schema:
          type: string
        in: query
        description: Filter by created_at
      - name: filter[completed]
        schema:
          type: string
        in: query
        description: Filter by completed
      - name: filter[error]
        schema:
          type: string
        in: query
        description: Filter by error
      - name: filter[try_count]
        schema:
          type: string
        in: query
        description: Filter by try_count
      - name: filter[printer_id]
        schema:
          type: string
        in: query
        description: Filter by printer_id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/printer_jobs"
    post:
      summary: Create a Printer Job
      tags:
      - Printer Job
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - printer_jobs
                    attributes:
                      "$ref": "#/components/schemas/printer_jobs"
                relationships:
                  type: object
                  properties:
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
                    printer:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printers
                    printable:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printables
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_jobs"
                  relationships:
                    type: object
                    properties:
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                      printer:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printers
                      printable:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printables
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/printer_clients"
                          - "$ref": "#/components/schemas/printers"
                          - "$ref": "#/components/schemas/printables"
  "/rate_quotes":
    post:
      summary: Create a Rate Quote
      tags:
      - Rate Quote
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - rate_quotes
                    attributes:
                      "$ref": "#/components/schemas/rate_quotes"
                relationships:
                  type: object
                  properties: {}
            examples:
              ? Order Channel Rate Quotes can quote an order channel for matching
                shipping rates. These quotes are used to display shipping options
                in e-commerce systems.
              : value:
                  data:
                    type: rate_quotes
                    attributes:
                      order_channel_id: 16
                      price: 199
                      weight: 100
                      delivery_address:
                        zip: '7400'
                        country_code: DK
                      items:
                      - quantity: 5
                        sku: sku123
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - rate_quotes
                      attributes:
                        "$ref": "#/components/schemas/rate_quotes"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/reports/{id}":
    get:
      summary: Show a single Report
      tags:
      - Report
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - reports
                      attributes:
                        "$ref": "#/components/schemas/reports"
                  relationships:
                    type: object
                    properties:
                      report_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - report_types
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/report_types"
                          - "$ref": "#/components/schemas/carriers"
    patch:
      summary: Update a Report
      tags:
      - Report
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - reports
                    attributes:
                      "$ref": "#/components/schemas/reports"
                relationships:
                  type: object
                  properties:
                    report_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - report_types
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - reports
                      attributes:
                        "$ref": "#/components/schemas/reports"
                  relationships:
                    type: object
                    properties:
                      report_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - report_types
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/report_types"
                          - "$ref": "#/components/schemas/carriers"
    delete:
      summary: Delete a Report
      tags:
      - Report
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - reports
                      attributes:
                        "$ref": "#/components/schemas/reports"
                  relationships:
                    type: object
                    properties:
                      report_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - report_types
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/report_types"
                          - "$ref": "#/components/schemas/carriers"
  "/reports":
    get:
      summary: List all Reports
      tags:
      - Report
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/reports"
    post:
      summary: Create a Report
      tags:
      - Report
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - reports
                    attributes:
                      "$ref": "#/components/schemas/reports"
                relationships:
                  type: object
                  properties:
                    report_type:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - report_types
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - reports
                      attributes:
                        "$ref": "#/components/schemas/reports"
                  relationships:
                    type: object
                    properties:
                      report_type:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - report_types
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/report_types"
                          - "$ref": "#/components/schemas/carriers"
  "/report_types/{id}":
    get:
      summary: Show a single Report Type
      tags:
      - Report Type
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - report_types
                      attributes:
                        "$ref": "#/components/schemas/report_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Report Type
      tags:
      - Report Type
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - report_types
                    attributes:
                      "$ref": "#/components/schemas/report_types"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - report_types
                      attributes:
                        "$ref": "#/components/schemas/report_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Report Type
      tags:
      - Report Type
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - report_types
                      attributes:
                        "$ref": "#/components/schemas/report_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/report_types":
    get:
      summary: List all Report Types
      tags:
      - Report Type
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/report_types"
    post:
      summary: Create a Report Type
      tags:
      - Report Type
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - report_types
                    attributes:
                      "$ref": "#/components/schemas/report_types"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - report_types
                      attributes:
                        "$ref": "#/components/schemas/report_types"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/printer_requeue_jobs/{id}":
    get:
      summary: Show a single Requeueable Printer Jobs
      tags:
      - Requeueable Printer Jobs
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_requeue_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_requeue_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Requeueable Printer Jobs
      tags:
      - Requeueable Printer Jobs
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - printer_requeue_jobs
                    attributes:
                      "$ref": "#/components/schemas/printer_requeue_jobs"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_requeue_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_requeue_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Requeueable Printer Jobs
      tags:
      - Requeueable Printer Jobs
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_requeue_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_requeue_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/printer_requeue_jobs":
    get:
      summary: List all Requeueable Printer Jobss
      tags:
      - Requeueable Printer Jobs
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/printer_requeue_jobs"
    post:
      summary: Create a Requeueable Printer Jobs
      tags:
      - Requeueable Printer Jobs
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - printer_requeue_jobs
                    attributes:
                      "$ref": "#/components/schemas/printer_requeue_jobs"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - printer_requeue_jobs
                      attributes:
                        "$ref": "#/components/schemas/printer_requeue_jobs"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/return_causes/{id}":
    get:
      summary: Show a single Return Causes
      tags:
      - Return Causes
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_causes
                      attributes:
                        "$ref": "#/components/schemas/return_causes"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
    patch:
      summary: Update a Return Causes
      tags:
      - Return Causes
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - return_causes
                    attributes:
                      "$ref": "#/components/schemas/return_causes"
                relationships:
                  type: object
                  properties:
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_causes
                      attributes:
                        "$ref": "#/components/schemas/return_causes"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
    delete:
      summary: Delete a Return Causes
      tags:
      - Return Causes
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_causes
                      attributes:
                        "$ref": "#/components/schemas/return_causes"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
  "/return_causes":
    get:
      summary: List all Return Causess
      tags:
      - Return Causes
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/return_causes"
    post:
      summary: Create a Return Causes
      tags:
      - Return Causes
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - return_causes
                    attributes:
                      "$ref": "#/components/schemas/return_causes"
                relationships:
                  type: object
                  properties:
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_causes
                      attributes:
                        "$ref": "#/components/schemas/return_causes"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
  "/return_lines/{id}":
    get:
      summary: Show a single Return Lines
      tags:
      - Return Lines
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_lines
                      attributes:
                        "$ref": "#/components/schemas/return_lines"
                  relationships:
                    type: object
                    properties:
                      return:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - returns
                      cause:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_causes
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                      refund_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_refund_methods
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/returns"
                          - "$ref": "#/components/schemas/return_causes"
                          - "$ref": "#/components/schemas/order_lines"
                          - "$ref": "#/components/schemas/return_refund_methods"
    patch:
      summary: Update a Return Lines
      tags:
      - Return Lines
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - return_lines
                    attributes:
                      "$ref": "#/components/schemas/return_lines"
                relationships:
                  type: object
                  properties:
                    return:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - returns
                    cause:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_causes
                    order_line:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_lines
                    refund_method:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_refund_methods
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_lines
                      attributes:
                        "$ref": "#/components/schemas/return_lines"
                  relationships:
                    type: object
                    properties:
                      return:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - returns
                      cause:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_causes
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                      refund_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_refund_methods
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/returns"
                          - "$ref": "#/components/schemas/return_causes"
                          - "$ref": "#/components/schemas/order_lines"
                          - "$ref": "#/components/schemas/return_refund_methods"
    delete:
      summary: Delete a Return Lines
      tags:
      - Return Lines
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_lines
                      attributes:
                        "$ref": "#/components/schemas/return_lines"
                  relationships:
                    type: object
                    properties:
                      return:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - returns
                      cause:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_causes
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                      refund_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_refund_methods
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/returns"
                          - "$ref": "#/components/schemas/return_causes"
                          - "$ref": "#/components/schemas/order_lines"
                          - "$ref": "#/components/schemas/return_refund_methods"
  "/return_lines":
    get:
      summary: List all Return Liness
      tags:
      - Return Lines
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/return_lines"
    post:
      summary: Create a Return Lines
      tags:
      - Return Lines
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - return_lines
                    attributes:
                      "$ref": "#/components/schemas/return_lines"
                relationships:
                  type: object
                  properties:
                    return:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - returns
                    cause:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_causes
                    order_line:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_lines
                    refund_method:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_refund_methods
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_lines
                      attributes:
                        "$ref": "#/components/schemas/return_lines"
                  relationships:
                    type: object
                    properties:
                      return:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - returns
                      cause:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_causes
                      order_line:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_lines
                      refund_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_refund_methods
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/returns"
                          - "$ref": "#/components/schemas/return_causes"
                          - "$ref": "#/components/schemas/order_lines"
                          - "$ref": "#/components/schemas/return_refund_methods"
  "/returns/{id}":
    get:
      summary: Show a single Return Order
      tags:
      - Return Order
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - returns
                      attributes:
                        "$ref": "#/components/schemas/returns"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_shipping_methods
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_shipping_methods"
                          - "$ref": "#/components/schemas/shipments"
    patch:
      summary: Update a Return Order
      tags:
      - Return Order
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - returns
                    attributes:
                      "$ref": "#/components/schemas/returns"
                relationships:
                  type: object
                  properties:
                    order:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - orders
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
                    shipping_method:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_shipping_methods
                    shipment:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipments
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - returns
                      attributes:
                        "$ref": "#/components/schemas/returns"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_shipping_methods
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_shipping_methods"
                          - "$ref": "#/components/schemas/shipments"
    delete:
      summary: Delete a Return Order
      tags:
      - Return Order
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - returns
                      attributes:
                        "$ref": "#/components/schemas/returns"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_shipping_methods
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_shipping_methods"
                          - "$ref": "#/components/schemas/shipments"
  "/returns":
    get:
      summary: List all Return Orders
      tags:
      - Return Order
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[secret]
        schema:
          type: string
        in: query
        description: Filter by secret
      - name: filter[activity_type]
        schema:
          type: string
        in: query
        description: Filter by activity_type
      - name: filter[status]
        schema:
          type: string
        in: query
        description: Filter by status
      - name: filter[portal_id]
        schema:
          type: string
        in: query
        description: Filter by portal_id
      - name: filter[free_text]
        schema:
          type: string
        in: query
        description: Filter by free_text
      - name: filter[return_causes]
        schema:
          type: string
        in: query
        description: Filter by return_causes
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/returns"
    post:
      summary: Create a Return Order
      tags:
      - Return Order
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - returns
                    attributes:
                      "$ref": "#/components/schemas/returns"
                relationships:
                  type: object
                  properties:
                    order:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - orders
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
                    shipping_method:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_shipping_methods
                    shipment:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipments
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - returns
                      attributes:
                        "$ref": "#/components/schemas/returns"
                  relationships:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_method:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_shipping_methods
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/return_shipping_methods"
                          - "$ref": "#/components/schemas/shipments"
  "/return_portals/{id}":
    get:
      summary: Show a single Return Portal
      tags:
      - Return Portal
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_portals
                      attributes:
                        "$ref": "#/components/schemas/return_portals"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      confirmation_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
    patch:
      summary: Update a Return Portal
      tags:
      - Return Portal
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - return_portals
                    attributes:
                      "$ref": "#/components/schemas/return_portals"
                relationships:
                  type: object
                  properties:
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    slip_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - slip_templates
                    mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    confirmation_mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_portals
                      attributes:
                        "$ref": "#/components/schemas/return_portals"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      confirmation_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
    delete:
      summary: Delete a Return Portal
      tags:
      - Return Portal
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_portals
                      attributes:
                        "$ref": "#/components/schemas/return_portals"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      confirmation_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/return_portals":
    get:
      summary: List all Return Portals
      tags:
      - Return Portal
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/return_portals"
    post:
      summary: Create a Return Portal
      tags:
      - Return Portal
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - return_portals
                    attributes:
                      "$ref": "#/components/schemas/return_portals"
                relationships:
                  type: object
                  properties:
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    slip_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - slip_templates
                    mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    confirmation_mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_portals
                      attributes:
                        "$ref": "#/components/schemas/return_portals"
                  relationships:
                    type: object
                    properties:
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      slip_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - slip_templates
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      confirmation_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/slip_templates"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/return_shipping_methods/{id}":
    get:
      summary: Show a single Return Shipping Method
      tags:
      - Return Shipping Method
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_shipping_methods
                      attributes:
                        "$ref": "#/components/schemas/return_shipping_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/shipping_rates"
    patch:
      summary: Update a Return Shipping Method
      tags:
      - Return Shipping Method
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - return_shipping_methods
                    attributes:
                      "$ref": "#/components/schemas/return_shipping_methods"
                relationships:
                  type: object
                  properties:
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_shipping_methods
                      attributes:
                        "$ref": "#/components/schemas/return_shipping_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/shipping_rates"
    delete:
      summary: Delete a Return Shipping Method
      tags:
      - Return Shipping Method
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_shipping_methods
                      attributes:
                        "$ref": "#/components/schemas/return_shipping_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/shipping_rates"
  "/return_shipping_methods":
    get:
      summary: List all Return Shipping Methods
      tags:
      - Return Shipping Method
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/return_shipping_methods"
    post:
      summary: Create a Return Shipping Method
      tags:
      - Return Shipping Method
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - return_shipping_methods
                    attributes:
                      "$ref": "#/components/schemas/return_shipping_methods"
                relationships:
                  type: object
                  properties:
                    portal:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - return_portals
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - return_shipping_methods
                      attributes:
                        "$ref": "#/components/schemas/return_shipping_methods"
                  relationships:
                    type: object
                    properties:
                      portal:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - return_portals
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/return_portals"
                          - "$ref": "#/components/schemas/shipping_rates"
  "/service_quotes":
    post:
      summary: Create a Service Quote
      tags:
      - Service Quote
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - service_quotes
                    attributes:
                      "$ref": "#/components/schemas/service_quotes"
                relationships:
                  type: object
                  properties: {}
            examples:
              Query available services by carrier ID. Assuming a Carrier exists with id 1.:
                value:
                  data:
                    type: service_quotes
                    attributes:
                      carrier_id: 1
                      is_return: false
                      send_time: '2025-05-06T10:25:51+02:00'
                      delivery_address:
                        address_1: Søndergade 2B
                        zip: '8600'
                        city: Silkeborg
                        country_code: DK
                      sender_address:
                        address_1: Lyngbygade 8
                        zip: '8600'
                        city: Silkeborg
                        country_code: DK
                      packages:
                      - weight: 500
                        weight_unit: g
                        dimensions:
                          width: 15
                          length: 15
                          height: 15
                          unit: cm
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - service_quotes
                      attributes:
                        "$ref": "#/components/schemas/service_quotes"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/shipments/{id}":
    get:
      summary: Show a single Shipment
      tags:
      - Shipment
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipments
                      attributes:
                        "$ref": "#/components/schemas/shipments"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                      original_shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                      pickup:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - pickups
                      shadow_shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                      return:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - returns
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_label_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/printer_clients"
                          - "$ref": "#/components/schemas/shipments"
                          - "$ref": "#/components/schemas/pickups"
                          - "$ref": "#/components/schemas/returns"
                          - "$ref": "#/components/schemas/document_templates"
                          - "$ref": "#/components/schemas/mail_templates"
  "/shipments":
    get:
      summary: List all Shipments
      tags:
      - Shipment
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[reference]
        schema:
          type: string
        in: query
        description: Filter by reference
      - name: filter[sorting_id]
        schema:
          type: string
        in: query
        description: Filter by sorting_id
      - name: filter[created_at]
        schema:
          type: string
        in: query
        description: Filter by created_at
      - name: filter[updated_at]
        schema:
          type: string
        in: query
        description: Filter by updated_at
      - name: filter[order]
        schema:
          type: string
        in: query
        description: Filter by order
      - name: filter[carrier]
        schema:
          type: string
        in: query
        description: Filter by carrier
      - name: filter[send_time]
        schema:
          type: string
        in: query
        description: Filter by send_time
      - name: filter[status]
        schema:
          type: string
        in: query
        description: Filter by status
      - name: filter[is_return]
        schema:
          type: string
        in: query
        description: Filter by is_return
      - name: filter[printer_client]
        schema:
          type: string
        in: query
        description: Filter by printer_client
      - name: filter[delivery_country_code]
        schema:
          type: string
        in: query
        description: Filter by delivery_country_code
      - name: filter[order_channel]
        schema:
          type: string
        in: query
        description: Filter by order_channel
      - name: filter[shipping_rate]
        schema:
          type: string
        in: query
        description: Filter by shipping_rate
      - name: filter[delivery_address]
        schema:
          type: string
        in: query
        description: Filter by delivery_address
      - name: filter[sender_address]
        schema:
          type: string
        in: query
        description: Filter by sender_address
      - name: filter[without_shadow_shipments]
        schema:
          type: string
        in: query
        description: Filter by without_shadow_shipments
      - name: filter[tracking_number]
        schema:
          type: string
        in: query
        description: Filter by tracking_number
      - name: filter[free_text]
        schema:
          type: string
        in: query
        description: Filter by free_text
      - name: filter[has_pickup]
        schema:
          type: string
        in: query
        description: Filter by has_pickup
      - name: filter[activity_type]
        schema:
          type: string
        in: query
        description: Filter by activity_type
      - name: filter[order_lines]
        schema:
          type: string
        in: query
        description: Filter by order_lines
      - name: filter[billing_contact]
        schema:
          type: string
        in: query
        description: Filter by billing_contact
      - name: filter[billing_email]
        schema:
          type: string
        in: query
        description: Filter by billing_email
      - name: filter[billing_company]
        schema:
          type: string
        in: query
        description: Filter by billing_company
      - name: filter[delivery_email]
        schema:
          type: string
        in: query
        description: Filter by delivery_email
      - name: filter[delivery_contact]
        schema:
          type: string
        in: query
        description: Filter by delivery_contact
      - name: filter[delivery_company]
        schema:
          type: string
        in: query
        description: Filter by delivery_company
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/shipments"
    post:
      summary: Create a Shipment
      tags:
      - Shipment
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - shipments
                    attributes:
                      "$ref": "#/components/schemas/shipments"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    order:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - orders
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
                    original_shipment:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipments
                    pickup:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - pickups
                    shadow_shipment:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipments
                    return:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - returns
                    document_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - document_templates
                    mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    return_label_mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
            examples:
              Create shipment for an order, with overridden printer client - shipping rate fetched from the order:
                value:
                  data:
                    type: shipments
                    relationships:
                      order:
                        data:
                          type: orders
                          id: 2341
                      printer_client:
                        data:
                          type: printer_clients
                          id: 12
              Partially send an order:
                value:
                  data:
                    type: shipments
                    attributes:
                      packages:
                      - ext_ref: ref123
                        weight: 100
                        weight_unit: g
                        dimensions:
                          unit: cm
                          height: 15
                          width: 15
                          length: 15
                        order_lines:
                        - id: 2
                        - id: 3
                    relationships:
                      order:
                        data:
                          type: orders
                          id: 2341
              Create a shipment with documents by attachemnt (attaching document with id 1) and direct upload:
                value:
                  data:
                    type: shipments
                    attributes:
                      included_documents:
                      - document_id: 1
                      - base64: "...."
                        document_format: PDF
                        document_size: A4
                        document_type: invoice
                    relationships:
                      order:
                        data:
                          type: orders
                          id: 123
              ? Create a shipment with service attributes and addons, the addon name,
                attribute key, type and potential dependencies are gotten from the
                addons and parameters fields in a service quote.
              : value:
                  data:
                    type: shipments
                    attributes:
                      service_attributes:
                      - attr_key: invoice_type
                        attr_value: proforma
                      - attr_key: cod_amount
                        attr_value: 512.5
                      add_ons:
                      - COD
                    relationships:
                      order:
                        data:
                          type: orders
                          id: 123
              Create shipment with a shipping rate:
                value:
                  data:
                    type: shipments
                    attributes:
                      sender_address:
                        company_name: Webshipper ApS
                        att_contact: Thomas
                        address_1: Lyngbygade 8
                        zip: '8600'
                        city: Silkeborg
                      delivery_address:
                        company_name: Test company
                        att_contact: Peter hansen
                        address_1: Silkeborgvej 291
                        zip: '8230'
                        city: Åbyhøj
                        country_code: DK
                      packages:
                      - ext_ref: ref123
                        weight: 100
                        weight_unit: g
                        dimensions:
                          unit: cm
                          height: 15
                          width: 15
                          length: 15
                    relationships:
                      shipping_rate:
                        data:
                          type: shipping_rates
                          id: 234
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipments
                      attributes:
                        "$ref": "#/components/schemas/shipments"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - orders
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                      original_shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                      pickup:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - pickups
                      shadow_shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                      return:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - returns
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_label_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/orders"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/printer_clients"
                          - "$ref": "#/components/schemas/shipments"
                          - "$ref": "#/components/schemas/pickups"
                          - "$ref": "#/components/schemas/returns"
                          - "$ref": "#/components/schemas/document_templates"
                          - "$ref": "#/components/schemas/mail_templates"
  "/shipping_addresses/{id}":
    get:
      summary: Show a single Shipping Address
      tags:
      - Shipping Address
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_addresses
                      attributes:
                        "$ref": "#/components/schemas/shipping_addresses"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Shipping Address
      tags:
      - Shipping Address
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - shipping_addresses
                    attributes:
                      "$ref": "#/components/schemas/shipping_addresses"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_addresses
                      attributes:
                        "$ref": "#/components/schemas/shipping_addresses"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Shipping Address
      tags:
      - Shipping Address
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_addresses
                      attributes:
                        "$ref": "#/components/schemas/shipping_addresses"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/shipping_addresses":
    get:
      summary: List all Shipping Addresss
      tags:
      - Shipping Address
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[att_contact]
        schema:
          type: string
        in: query
        description: Filter by att_contact
      - name: filter[company_name]
        schema:
          type: string
        in: query
        description: Filter by company_name
      - name: filter[address_1]
        schema:
          type: string
        in: query
        description: Filter by address_1
      - name: filter[address_2]
        schema:
          type: string
        in: query
        description: Filter by address_2
      - name: filter[country_code]
        schema:
          type: string
        in: query
        description: Filter by country_code
      - name: filter[state]
        schema:
          type: string
        in: query
        description: Filter by state
      - name: filter[zip]
        schema:
          type: string
        in: query
        description: Filter by zip
      - name: filter[address_type]
        schema:
          type: string
        in: query
        description: Filter by address_type
      - name: filter[search]
        schema:
          type: string
        in: query
        description: Filter by search
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/shipping_addresses"
    post:
      summary: Create a Shipping Address
      tags:
      - Shipping Address
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - shipping_addresses
                    attributes:
                      "$ref": "#/components/schemas/shipping_addresses"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_addresses
                      attributes:
                        "$ref": "#/components/schemas/shipping_addresses"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/shipping_mappings/{id}":
    get:
      summary: Show a single Shipping Mapping
      tags:
      - Shipping Mapping
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_mappings
                      attributes:
                        "$ref": "#/components/schemas/shipping_mappings"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/order_channels"
    patch:
      summary: Update a Shipping Mapping
      tags:
      - Shipping Mapping
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - shipping_mappings
                    attributes:
                      "$ref": "#/components/schemas/shipping_mappings"
                relationships:
                  type: object
                  properties:
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_mappings
                      attributes:
                        "$ref": "#/components/schemas/shipping_mappings"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/order_channels"
    delete:
      summary: Delete a Shipping Mapping
      tags:
      - Shipping Mapping
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_mappings
                      attributes:
                        "$ref": "#/components/schemas/shipping_mappings"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/order_channels"
  "/shipping_mappings":
    get:
      summary: List all Shipping Mappings
      tags:
      - Shipping Mapping
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[order_channel_id]
        schema:
          type: string
        in: query
        description: Filter by order_channel_id
      - name: filter[order_channel]
        schema:
          type: string
        in: query
        description: Filter by order_channel
      - name: filter[shipping_code]
        schema:
          type: string
        in: query
        description: Filter by shipping_code
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/shipping_mappings"
    post:
      summary: Create a Shipping Mapping
      tags:
      - Shipping Mapping
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - shipping_mappings
                    attributes:
                      "$ref": "#/components/schemas/shipping_mappings"
                relationships:
                  type: object
                  properties:
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_mappings
                      attributes:
                        "$ref": "#/components/schemas/shipping_mappings"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/order_channels"
  "/shipping_rates/{id}":
    get:
      summary: Show a single Shipping Rate
      tags:
      - Shipping Rate
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_rates
                      attributes:
                        "$ref": "#/components/schemas/shipping_rates"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      return_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      shadow_booking_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/document_templates"
    patch:
      summary: Update a Shipping Rate
      tags:
      - Shipping Rate
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - shipping_rates
                    attributes:
                      "$ref": "#/components/schemas/shipping_rates"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    return_shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    return_mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    document_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - document_templates
                    shadow_booking_shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_rates
                      attributes:
                        "$ref": "#/components/schemas/shipping_rates"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      return_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      shadow_booking_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/document_templates"
    delete:
      summary: Delete a Shipping Rate
      tags:
      - Shipping Rate
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_rates
                      attributes:
                        "$ref": "#/components/schemas/shipping_rates"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      return_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      shadow_booking_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/document_templates"
  "/shipping_rates":
    get:
      summary: List all Shipping Rates
      tags:
      - Shipping Rate
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[order_channel_id]
        schema:
          type: string
        in: query
        description: Filter by order_channel_id
      - name: filter[is_return]
        schema:
          type: string
        in: query
        description: Filter by is_return
      - name: filter[is_hidden]
        schema:
          type: string
        in: query
        description: Filter by is_hidden
      - name: filter[service_code]
        schema:
          type: string
        in: query
        description: Filter by service_code
      - name: filter[shadow_bookings]
        schema:
          type: string
        in: query
        description: Filter by shadow_bookings
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/shipping_rates"
    post:
      summary: Create a Shipping Rate
      tags:
      - Shipping Rate
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - shipping_rates
                    attributes:
                      "$ref": "#/components/schemas/shipping_rates"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    order_channel:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - order_channels
                    return_shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    return_mail_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - mail_templates
                    document_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - document_templates
                    shadow_booking_shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - shipping_rates
                      attributes:
                        "$ref": "#/components/schemas/shipping_rates"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      order_channel:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - order_channels
                      return_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      return_mail_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - mail_templates
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      shadow_booking_shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/order_channels"
                          - "$ref": "#/components/schemas/shipping_rates"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/mail_templates"
                          - "$ref": "#/components/schemas/document_templates"
  "/expressions/{id}":
    get:
      summary: Show a single Shipping Rate Expression
      tags:
      - Shipping Rate Expression
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - expressions
                      attributes:
                        "$ref": "#/components/schemas/expressions"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Shipping Rate Expression
      tags:
      - Shipping Rate Expression
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - expressions
                    attributes:
                      "$ref": "#/components/schemas/expressions"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - expressions
                      attributes:
                        "$ref": "#/components/schemas/expressions"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Shipping Rate Expression
      tags:
      - Shipping Rate Expression
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - expressions
                      attributes:
                        "$ref": "#/components/schemas/expressions"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/expressions":
    get:
      summary: List all Shipping Rate Expressions
      tags:
      - Shipping Rate Expression
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/expressions"
    post:
      summary: Create a Shipping Rate Expression
      tags:
      - Shipping Rate Expression
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - expressions
                    attributes:
                      "$ref": "#/components/schemas/expressions"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - expressions
                      attributes:
                        "$ref": "#/components/schemas/expressions"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/regions/{id}":
    get:
      summary: Show a single Shipping Region
      tags:
      - Shipping Region
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - regions
                      attributes:
                        "$ref": "#/components/schemas/regions"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
    patch:
      summary: Update a Shipping Region
      tags:
      - Shipping Region
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - regions
                    attributes:
                      "$ref": "#/components/schemas/regions"
                relationships:
                  type: object
                  properties:
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - regions
                      attributes:
                        "$ref": "#/components/schemas/regions"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
    delete:
      summary: Delete a Shipping Region
      tags:
      - Shipping Region
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - regions
                      attributes:
                        "$ref": "#/components/schemas/regions"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
  "/regions":
    get:
      summary: List all Shipping Regions
      tags:
      - Shipping Region
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/regions"
    post:
      summary: Create a Shipping Region
      tags:
      - Shipping Region
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - regions
                    attributes:
                      "$ref": "#/components/schemas/regions"
                relationships:
                  type: object
                  properties:
                    shipping_rate:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_rates
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - regions
                      attributes:
                        "$ref": "#/components/schemas/regions"
                  relationships:
                    type: object
                    properties:
                      shipping_rate:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_rates
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_rates"
  "/slip_templates/{id}":
    get:
      summary: Show a single Slip Template
      tags:
      - Slip Template
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_templates
                      attributes:
                        "$ref": "#/components/schemas/slip_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Slip Template
      tags:
      - Slip Template
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - slip_templates
                    attributes:
                      "$ref": "#/components/schemas/slip_templates"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_templates
                      attributes:
                        "$ref": "#/components/schemas/slip_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Slip Template
      tags:
      - Slip Template
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_templates
                      attributes:
                        "$ref": "#/components/schemas/slip_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/slip_templates":
    get:
      summary: List all Slip Templates
      tags:
      - Slip Template
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[returns_only]
        schema:
          type: string
        in: query
        description: Filter by returns_only
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/slip_templates"
    post:
      summary: Create a Slip Template
      tags:
      - Slip Template
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - slip_templates
                    attributes:
                      "$ref": "#/components/schemas/slip_templates"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_templates
                      attributes:
                        "$ref": "#/components/schemas/slip_templates"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/slip_template_previews/{id}":
    get:
      summary: Show a single Slip Template Preview
      tags:
      - Slip Template Preview
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_template_previews
                      attributes:
                        "$ref": "#/components/schemas/slip_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Slip Template Preview
      tags:
      - Slip Template Preview
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - slip_template_previews
                    attributes:
                      "$ref": "#/components/schemas/slip_template_previews"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_template_previews
                      attributes:
                        "$ref": "#/components/schemas/slip_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Slip Template Preview
      tags:
      - Slip Template Preview
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_template_previews
                      attributes:
                        "$ref": "#/components/schemas/slip_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/slip_template_previews":
    get:
      summary: List all Slip Template Previews
      tags:
      - Slip Template Preview
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/slip_template_previews"
    post:
      summary: Create a Slip Template Preview
      tags:
      - Slip Template Preview
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - slip_template_previews
                    attributes:
                      "$ref": "#/components/schemas/slip_template_previews"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - slip_template_previews
                      attributes:
                        "$ref": "#/components/schemas/slip_template_previews"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/stores/{id}":
    get:
      summary: Show a single Store
      tags:
      - Store
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - stores
                      attributes:
                        "$ref": "#/components/schemas/stores"
                  relationships:
                    type: object
                    properties:
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_addresses"
    patch:
      summary: Update a Store
      tags:
      - Store
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - stores
                    attributes:
                      "$ref": "#/components/schemas/stores"
                relationships:
                  type: object
                  properties:
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    pickup_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    sold_from_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - stores
                      attributes:
                        "$ref": "#/components/schemas/stores"
                  relationships:
                    type: object
                    properties:
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_addresses"
    delete:
      summary: Delete a Store
      tags:
      - Store
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - stores
                      attributes:
                        "$ref": "#/components/schemas/stores"
                  relationships:
                    type: object
                    properties:
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/stores":
    get:
      summary: List all Stores
      tags:
      - Store
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/stores"
    post:
      summary: Create a Store
      tags:
      - Store
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - stores
                    attributes:
                      "$ref": "#/components/schemas/stores"
                relationships:
                  type: object
                  properties:
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    return_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    pickup_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    sold_from_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - stores
                      attributes:
                        "$ref": "#/components/schemas/stores"
                  relationships:
                    type: object
                    properties:
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      return_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      pickup_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sold_from_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/shipping_addresses"
  "/tags":
    get:
      summary: List all Tags
      tags:
      - Tag
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/tags"
  "/tracking_events/{id}":
    get:
      summary: Show a single Tracking Event
      tags:
      - Tracking Event
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - tracking_events
                      attributes:
                        "$ref": "#/components/schemas/tracking_events"
                  relationships:
                    type: object
                    properties:
                      package:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - packages
                      shipment:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipments
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/packages"
                          - "$ref": "#/components/schemas/shipments"
  "/tracking_events":
    get:
      summary: List all Tracking Events
      tags:
      - Tracking Event
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[created_at]
        schema:
          type: string
        in: query
        description: Filter by created_at
      - name: filter[shipment_id]
        schema:
          type: string
        in: query
        description: Filter by shipment_id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/tracking_events"
  "/triggers/{id}":
    get:
      summary: Show a single Trigger
      tags:
      - Trigger
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - triggers
                      attributes:
                        "$ref": "#/components/schemas/triggers"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
    patch:
      summary: Update a Trigger
      tags:
      - Trigger
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - triggers
                    attributes:
                      "$ref": "#/components/schemas/triggers"
                relationships:
                  type: object
                  properties:
                    automation:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - automations
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - triggers
                      attributes:
                        "$ref": "#/components/schemas/triggers"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
    delete:
      summary: Delete a Trigger
      tags:
      - Trigger
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - triggers
                      attributes:
                        "$ref": "#/components/schemas/triggers"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
  "/triggers":
    get:
      summary: List all Triggers
      tags:
      - Trigger
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/triggers"
    post:
      summary: Create a Trigger
      tags:
      - Trigger
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - triggers
                    attributes:
                      "$ref": "#/components/schemas/triggers"
                relationships:
                  type: object
                  properties:
                    automation:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - automations
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - triggers
                      attributes:
                        "$ref": "#/components/schemas/triggers"
                  relationships:
                    type: object
                    properties:
                      automation:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - automations
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/automations"
  "/users/{id}":
    get:
      summary: Show a single User
      tags:
      - User
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - users
                      attributes:
                        "$ref": "#/components/schemas/users"
                  relationships:
                    type: object
                    properties:
                      user_group:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - user_groups
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/user_groups"
                          - "$ref": "#/components/schemas/printer_clients"
    patch:
      summary: Update a User
      tags:
      - User
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - users
                    attributes:
                      "$ref": "#/components/schemas/users"
                relationships:
                  type: object
                  properties:
                    user_group:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - user_groups
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - users
                      attributes:
                        "$ref": "#/components/schemas/users"
                  relationships:
                    type: object
                    properties:
                      user_group:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - user_groups
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/user_groups"
                          - "$ref": "#/components/schemas/printer_clients"
    delete:
      summary: Delete a User
      tags:
      - User
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - users
                      attributes:
                        "$ref": "#/components/schemas/users"
                  relationships:
                    type: object
                    properties:
                      user_group:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - user_groups
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/user_groups"
                          - "$ref": "#/components/schemas/printer_clients"
  "/users":
    get:
      summary: List all Users
      tags:
      - User
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/users"
    post:
      summary: Create a User
      tags:
      - User
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - users
                    attributes:
                      "$ref": "#/components/schemas/users"
                relationships:
                  type: object
                  properties:
                    user_group:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - user_groups
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - users
                      attributes:
                        "$ref": "#/components/schemas/users"
                  relationships:
                    type: object
                    properties:
                      user_group:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - user_groups
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/user_groups"
                          - "$ref": "#/components/schemas/printer_clients"
  "/user_groups/{id}":
    get:
      summary: Show a single User Group
      tags:
      - User Group
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - user_groups
                      attributes:
                        "$ref": "#/components/schemas/user_groups"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a User Group
      tags:
      - User Group
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - user_groups
                    attributes:
                      "$ref": "#/components/schemas/user_groups"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - user_groups
                      attributes:
                        "$ref": "#/components/schemas/user_groups"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a User Group
      tags:
      - User Group
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - user_groups
                      attributes:
                        "$ref": "#/components/schemas/user_groups"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/user_groups":
    get:
      summary: List all User Groups
      tags:
      - User Group
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/user_groups"
    post:
      summary: Create a User Group
      tags:
      - User Group
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - user_groups
                    attributes:
                      "$ref": "#/components/schemas/user_groups"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - user_groups
                      attributes:
                        "$ref": "#/components/schemas/user_groups"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/waybills/{id}":
    get:
      summary: Show a single Waybill
      tags:
      - Waybill
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - waybills
                      attributes:
                        "$ref": "#/components/schemas/waybills"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      sold_to_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/document_templates"
                          - "$ref": "#/components/schemas/printer_clients"
    patch:
      summary: Update a Waybill
      tags:
      - Waybill
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - waybills
                    attributes:
                      "$ref": "#/components/schemas/waybills"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    sold_to_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    document_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - document_templates
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - waybills
                      attributes:
                        "$ref": "#/components/schemas/waybills"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      sold_to_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/document_templates"
                          - "$ref": "#/components/schemas/printer_clients"
    delete:
      summary: Delete a Waybill
      tags:
      - Waybill
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - waybills
                      attributes:
                        "$ref": "#/components/schemas/waybills"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      sold_to_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/document_templates"
                          - "$ref": "#/components/schemas/printer_clients"
  "/waybills":
    get:
      summary: List all Waybills
      tags:
      - Waybill
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      - name: filter[status]
        schema:
          type: string
        in: query
        description: Filter by status
      - name: filter[carrier]
        schema:
          type: string
        in: query
        description: Filter by carrier
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/waybills"
    post:
      summary: Create a Waybill
      tags:
      - Waybill
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - waybills
                    attributes:
                      "$ref": "#/components/schemas/waybills"
                relationships:
                  type: object
                  properties:
                    carrier:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - carriers
                    sold_to_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    sender_address:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - shipping_addresses
                    document_template:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - document_templates
                    printer_client:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - printer_clients
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - waybills
                      attributes:
                        "$ref": "#/components/schemas/waybills"
                  relationships:
                    type: object
                    properties:
                      carrier:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - carriers
                      sold_to_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      sender_address:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - shipping_addresses
                      document_template:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - document_templates
                      printer_client:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - printer_clients
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/carriers"
                          - "$ref": "#/components/schemas/shipping_addresses"
                          - "$ref": "#/components/schemas/document_templates"
                          - "$ref": "#/components/schemas/printer_clients"
  "/webhooks/{id}":
    get:
      summary: Show a single Webhook
      tags:
      - Webhook
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhooks
                      attributes:
                        "$ref": "#/components/schemas/webhooks"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    patch:
      summary: Update a Webhook
      tags:
      - Webhook
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - webhooks
                    attributes:
                      "$ref": "#/components/schemas/webhooks"
                relationships:
                  type: object
                  properties: {}
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhooks
                      attributes:
                        "$ref": "#/components/schemas/webhooks"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
    delete:
      summary: Delete a Webhook
      tags:
      - Webhook
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhooks
                      attributes:
                        "$ref": "#/components/schemas/webhooks"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/webhooks":
    get:
      summary: List all Webhooks
      tags:
      - Webhook
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/webhooks"
    post:
      summary: Create a Webhook
      tags:
      - Webhook
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - webhooks
                    attributes:
                      "$ref": "#/components/schemas/webhooks"
                relationships:
                  type: object
                  properties: {}
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhooks
                      attributes:
                        "$ref": "#/components/schemas/webhooks"
                  relationships:
                    type: object
                    properties: {}
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf: []
  "/webhook_failures/{id}":
    get:
      summary: Show a single Webhook Failure
      tags:
      - Webhook Failure
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhook_failures
                      attributes:
                        "$ref": "#/components/schemas/webhook_failures"
                  relationships:
                    type: object
                    properties:
                      webhook:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - webhooks
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/webhooks"
    patch:
      summary: Update a Webhook Failure
      tags:
      - Webhook Failure
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    id:
                      type: integer
                    type:
                      type: string
                      enum:
                      - webhook_failures
                    attributes:
                      "$ref": "#/components/schemas/webhook_failures"
                relationships:
                  type: object
                  properties:
                    webhook:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - webhooks
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhook_failures
                      attributes:
                        "$ref": "#/components/schemas/webhook_failures"
                  relationships:
                    type: object
                    properties:
                      webhook:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - webhooks
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/webhooks"
    delete:
      summary: Delete a Webhook Failure
      tags:
      - Webhook Failure
      parameters:
      - name: id
        in: path
        schema:
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhook_failures
                      attributes:
                        "$ref": "#/components/schemas/webhook_failures"
                  relationships:
                    type: object
                    properties:
                      webhook:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - webhooks
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/webhooks"
  "/webhook_failures":
    get:
      summary: List all Webhook Failures
      tags:
      - Webhook Failure
      parameters:
      - name: filter[id]
        schema:
          type: string
        in: query
        description: Filter by id
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        attributes:
                          "$ref": "#/components/schemas/webhook_failures"
    post:
      summary: Create a Webhook Failure
      tags:
      - Webhook Failure
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - webhook_failures
                    attributes:
                      "$ref": "#/components/schemas/webhook_failures"
                relationships:
                  type: object
                  properties:
                    webhook:
                      type: object
                      properties:
                        data:
                          type: object
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                              - webhooks
            examples: {}
      responses:
        '204':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      type:
                        type: string
                        enum:
                        - webhook_failures
                      attributes:
                        "$ref": "#/components/schemas/webhook_failures"
                  relationships:
                    type: object
                    properties:
                      webhook:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              id:
                                type: string
                              type:
                                type: string
                                enum:
                                - webhooks
                  included:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                          - orders
                          - shipments
                        id:
                          type: integer
                        data:
                          oneOf:
                          - "$ref": "#/components/schemas/webhooks"
components:
  schemas:
    brands:
      type: object
      properties:
        documents:
          description: ''
          type: string
          readOnly: true
    return_refund_methods:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        description:
          description: ''
          type: string
          readOnly: false
        allowed_days:
          description: ''
          type: integer
          readOnly: false
        payment_required:
          description: ''
          type: boolean
          readOnly: false
        excluded_skus:
          description: ''
          type: string
          readOnly: false
    actions:
      type: object
      properties:
        job_type:
          description: 'Name of a supported job: <ul> <li> CreateShipmentJob </li>
            </ul>'
          type: string
          readOnly: false
        async:
          description: If true, this action runs as a background process, if not it
            runs immediately
          type: boolean
          readOnly: false
        additional_attributes:
          description: Array of objects containing keys <code>attr_values</code> and
            <code>attr_value</code>
          type: array
          readOnly: false
          items:
            type: string
        priority:
          description: ''
          type: integer
          readOnly: false
    activities:
      type: object
      properties:
        details:
          description: Details of the activity
          type: string
          readOnly: false
        latitude:
          description: Latitude of the activity
          type: number
          readOnly: false
        longitude:
          description: Longitude of the activity
          type: number
          readOnly: false
        signature:
          description: Base64 encoded signature of the activity
          type: string
          readOnly: false
        signature_name:
          description: Name of the signature
          type: string
          readOnly: false
        photo:
          description: Base64 encoded photo of the activity
          type: string
          readOnly: false
        initiator:
          description: Initiator of the activity
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    activity_types:
      type: object
      properties:
        activity_description:
          description: Description of the activity
          type: string
          readOnly: false
        activity_key:
          description: Key for the activity
          type: string
          readOnly: false
        model:
          description: Model for the activity
          type: string
          readOnly: false
        model_status:
          description: Status of the model
          type: string
          readOnly: false
        requires_signature:
          description: Does the activity require a signature
          type: boolean
          readOnly: false
        requires_photo:
          description: Does the activity require a photo
          type: boolean
          readOnly: false
        active:
          description: Is the activity active
          type: boolean
          readOnly: false
        priority:
          description: Priority of the activity
          type: integer
          readOnly: false
    additional_attributes:
      type: object
      properties:
        name:
          description: Visible name of the attribute
          type: string
          readOnly: false
        attr_key:
          description: Key for the attribute
          type: string
          readOnly: false
        attr_value:
          description: Value of the attribute
          type: string
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    attachments:
      type: object
      properties:
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    automations:
      type: object
      properties:
        trigger:
          description: Flattened resource of type Trigger
          type: object
          readOnly: false
        actions:
          description: 'Array of flattened resources of type Action '
          type: array
          readOnly: false
          items:
            type: string
        name:
          description: ''
          type: string
          readOnly: false
        enabled:
          description: ''
          type: boolean
          readOnly: false
        priority:
          description: ''
          type: integer
          readOnly: false
        automation_type:
          description: ''
          type: integer
          readOnly: false
    automations_dry_runs:
      type: object
      properties:
        dry_run:
          description: ''
          type: string
          readOnly: false
        automation:
          description: ''
          type: string
          readOnly: false
        shipment_id:
          description: ''
          type: string
          readOnly: false
        order_id:
          description: ''
          type: string
          readOnly: false
        report_id:
          description: ''
          type: string
          readOnly: false
        model_type:
          description: ''
          type: string
          readOnly: false
        element_name:
          description: ''
          type: string
          readOnly: false
    barcode_ranges:
      type: object
      properties:
        barcode_type:
          description: String like DPD or SSCC
          type: string
          readOnly: false
        serial_from:
          description: The first barcode in the range
          type: integer
          readOnly: false
        serial_to:
          description: The last barcode in the range
          type: integer
          readOnly: false
        current_serial:
          description: The last used (highest) barcode serial
          type: integer
          readOnly: true
        usage_status:
          description: ''
          type: integer
          readOnly: false
        replaces_id:
          description: ''
          type: string
          readOnly: false
    bulk_import_orders:
      type: object
      properties:
        ids:
          description: Order ids to import from the order channel
          type: string
          readOnly: false
        order_channel_id:
          description: Id of the order channel to import orders from
          type: string
          readOnly: false
        async:
          description: Run the import asyncronously, default is false unless importing
            more than one order or from more than one order channel
          type: string
          readOnly: false
        reimport:
          description: 'Reimport orders from the order channel. WARNING: This will
            overwrite any changes to the order made in Webshipper and import the order
            as it is in the order channel'
          type: string
          readOnly: false
        time_start:
          description: Time from when orders should be imported, all orders after
            this time is imported from the order channel. This option is not supported
            by all order channels and there might be some limitations depending on
            the order channel
          type: string
          readOnly: false
        time_end:
          description: Time to when orders should be imported, all orders before this
            time is imported from the order channel. This option is not supported
            by all order channels and there might be some limitations depending on
            the order channel
          type: string
          readOnly: false
        statuses:
          description: Statuses of orders to import, all orders with the given statuses
            are imported from the order channel. This option is not supported by all
            order channels and there might be some limitations depending on the order
            channel
          type: string
          readOnly: false
        bulk_imports:
          description: List of bulk imports with the same attributes as above. This
            can be used to import multiple orders from multiple order channels at
            once. Options specified in the root object is used globally, but is overridable
            by specififying the option for specific bulk_import in the list.
          type: string
          readOnly: false
        source:
          description: Source of the orders to import. This will default to API
          type: string
          readOnly: false
    csv_mappings:
      type: object
      properties:
        separator:
          description: The seperator in the file. Normally ';' or ','
          type: string
          readOnly: false
        target_class:
          description: Must be one of the models <code>Order</code> or <code>Shipment</code>
          type: string
          readOnly: false
        grouped_by:
          description: Must be the index of the Order ID
          type: integer
          readOnly: false
        grouped_path:
          description: 'The sub-model which you are grouping. For order: order_lines_attributes'
          type: string
          readOnly: false
        includes_header:
          description: Determines if there is an ignorable header line in the file
          type: boolean
          readOnly: false
        lines_as_package:
          description: ''
          type: boolean
          readOnly: false
        recreate_order_lines:
          description: ''
          type: boolean
          readOnly: false
        separate_order_line_mapping:
          description: ''
          type: boolean
          readOnly: false
        name:
          description: Name of the configuration
          type: string
          readOnly: false
        example_input:
          description: Example input to make it easier to create the mapping in the
            UI.
          type: string
          readOnly: false
        line_example_input:
          description: ''
          type: string
          readOnly: false
        rules:
          description: Array of flattened resources of the type CSV Rule
          type: array
          readOnly: false
          items:
            type: string
        shipment_export_format:
          description: ''
          type: string
          readOnly: false
        order_export_format:
          description: ''
          type: string
          readOnly: false
        create_shipment_automatically:
          description: ''
          type: boolean
          readOnly: false
        force_async:
          description: ''
          type: boolean
          readOnly: false
        concat_paths:
          description: ''
          type: boolean
          readOnly: false
        split_large_records:
          description: ''
          type: boolean
          readOnly: false
        export_file_extension:
          description: ''
          type: string
          readOnly: false
    csv_rules:
      type: object
      properties:
        target_path:
          description: Path of the attribute to update
          type: string
          readOnly: false
        source_index:
          description: The index of the field in the CSV file to be mapped
          type: integer
          readOnly: false
        default_value:
          description: Value to use if the value in the CSV file is empty or missing
          type: string
          readOnly: false
        input_conversions:
          description: A key/value mapping for converting values before creating the
            object
          type: object
          readOnly: false
    csv_uploads:
      type: object
      properties:
        imported:
          description: A list of ids of the imported records
          type: array
          readOnly: true
          items:
            type: string
        input:
          description: The raw CSV data
          type: string
          readOnly: false
        input_url:
          description: ''
          type: string
          readOnly: false
        import_errors:
          description: A list of error messages for items that could not be imported
          type: array
          readOnly: true
          items:
            type: string
        async:
          description: If set to true, the import will be performed in background.
            Highly recommended for imports larger than 100 rows.
          type: boolean
          readOnly: false
        make_exportable:
          description: ''
          type: boolean
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    carriers:
      type: object
      properties:
        alias:
          description: Your name for the carrier
          type: string
          readOnly: false
        services:
          description: Array of services provided by this Carrier
          type: string
          readOnly: false
        attrs:
          description: |-
            Array of hashes with keys: <code>attr_key</code>, <code>attr_value</code>, <code>attr_name</code>, <code>attr_type</code>, <code>is_required</code>, <code>only_visible_on_creation</code>, </code>enums</code>. See
                  documentation for Local Attributes
          type: string
          readOnly: false
        prefer_zpl:
          description: ''
          type: boolean
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        is_approved:
          description: ''
          type: boolean
          readOnly: false
        approved_service_codes:
          description: ''
          type: string
          readOnly: false
        service_parameter_enums:
          description: ''
          type: string
          readOnly: false
        barcode_notification_behavior:
          description: ''
          type: integer
          readOnly: false
        barcode_notification_mail:
          description: ''
          type: string
          readOnly: false
        has_active_cost_sheet:
          description: ''
          type: string
          readOnly: false
        delete_at_carrier:
          description: ''
          type: boolean
          readOnly: false
        test_mode:
          description: ''
          type: boolean
          readOnly: false
        logo:
          description: ''
          type: string
          readOnly: false
        logo_url:
          description: ''
          type: string
          readOnly: false
        print_error_label:
          description: ''
          type: boolean
          readOnly: false
        ftp_configuration_id:
          description: ''
          type: integer
          readOnly: false
    carrier_accesses:
      type: object
      properties:
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
    carrier_types:
      type: object
      properties:
        fulfillment_logo:
          description: Logo for the carrier
          type: string
          readOnly: false
        list_logo:
          description: Logo for the carrier
          type: string
          readOnly: false
        name:
          description: Name of the carrier
          type: string
          readOnly: false
        carrier_code:
          description: Code identifying the carrier
          type: string
          readOnly: false
        description:
          description: Description of the carrier
          type: string
          readOnly: false
        required_details:
          description: Details required to use the carrier
          type: string
          readOnly: false
        requires_dutiable:
          description: ''
          type: boolean
          readOnly: false
        supports_zpl:
          description: ''
          type: boolean
          readOnly: false
        supports_pickup:
          description: ''
          type: string
          readOnly: false
        supports_tracking:
          description: ''
          type: string
          readOnly: false
        supports_price_quoting:
          description: ''
          type: boolean
          readOnly: false
        requires_approval:
          description: ''
          type: boolean
          readOnly: false
        supports_documents:
          description: ''
          type: boolean
          readOnly: false
        supports_shipment_updates:
          description: Boolean indicating wether the carrier supports shipment updates
          type: boolean
          readOnly: false
        shipment_updates_limit_minutes:
          description: Number of minutes before shipment time a shipment can be updated
          type: integer
          readOnly: false
        barcode_mail:
          description: ''
          type: string
          readOnly: false
        supports_price_pdf_upload:
          description: ''
          type: string
          readOnly: false
        supports_deletion:
          description: ''
          type: string
          readOnly: false
        barcode_customer_notification_mail_template_id:
          description: ''
          type: integer
          readOnly: false
        colli_type_support:
          description: 'Determines whether the carrier supports colli types.Values
            should be one of the following. null: Not supported, "carrier_provided":
            Values are determined by the carrier, "webshipper_provided": Default Webshipper
            colli types, "customer_provided": The customer can input colli types specific
            to their aggreement with the carrier.'
          type: integer
          readOnly: false
        beta:
          description: ''
          type: boolean
          readOnly: false
        supports_test_mode:
          description: ''
          type: boolean
          readOnly: false
        show_send_time:
          description: ''
          type: boolean
          readOnly: false
        supports_shadow_bookings:
          description: ''
          type: boolean
          readOnly: false
        rate_quote_validation:
          description: ''
          type: boolean
          readOnly: false
        carrier_group_id:
          description: ''
          type: string
          readOnly: false
        require_ftp_configuration_id:
          description: ''
          type: boolean
          readOnly: false
        hide:
          description: ''
          type: boolean
          readOnly: false
        onboarding_url:
          description: ''
          type: string
          readOnly: false
        is_edi:
          description: ''
          type: boolean
          readOnly: false
    comments:
      type: object
      properties:
        comment:
          description: The comment text.
          type: string
          readOnly: false
        initiator:
          description: The user that created the comment.
          type: string
          readOnly: false
        comment_type:
          description: 'The type of comment. Possible values: ''internal_comment''
            or ''external_comment'''
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    customs_lines:
      type: object
      properties:
        sku:
          description: Stock Keeping Unit
          type: string
          readOnly: false
        description:
          description: Goods description
          type: string
          readOnly: false
        quantity:
          description: Quantity of the customs line
          type: integer
          readOnly: false
        tarif_number:
          description: Tariff number / HS code
          type: string
          readOnly: false
        country_of_origin:
          description: Country of origin of the customs line - ISO 3166-1 alpha-2
          type: string
          readOnly: false
        unit_price:
          description: Unit price of a single quantity customs line
          type: number
          readOnly: false
        vat_percent:
          description: Vat percent of the customs line
          type: number
          readOnly: false
        currency:
          description: Currency ISO-4217
          type: string
          readOnly: false
        weight:
          description: Weight of a single quantity customs line
          type: number
          readOnly: false
        weight_unit:
          description: Weight unit of the customs line - One of 'g', 'oz', 'lbs' or
            'kg'
          type: integer
          readOnly: false
        discount:
          description: Discount of a single quantity customs line
          type: number
          readOnly: false
        dangerous_goods_details:
          description: 'Optional object of key value pairs used for providing information
            of dangerous goods. For use with DGOffice, use keys: article_no, package_type_id
            and packaging_instruction_type.'
          type: object
          readOnly: false
    documents:
      type: object
      properties:
        shipment_id:
          description: Id of the shipment it belongs to
          type: integer
          readOnly: false
        document_size:
          description: 'Enum for the paper size. valid values: <code>A4</code>'
          type: string
          readOnly: false
        document_format:
          description: 'Enum for the document format. Valid values: <code>PDF</code>'
          type: string
          readOnly: false
        base64:
          description: Base64 representation of the document. Only required when creating.
          type: string
          readOnly: false
        is_special:
          description: Used to indicate if this document is a special document, like
            static customs documents. Special documents will be displayed in Webshipper
            under Settings > Documents.
          type: boolean
          readOnly: false
        name:
          description: Used for special documents
          type: string
          readOnly: false
        description:
          description: Used for special documents
          type: string
          readOnly: false
        document_type:
          description: 'One of: ''shipping_document'', ''other'', ''customs_document'',
            ''invoice'', ''certificate'', ''proforma'', ''nafta_certificate'', ''commercial'',
            ''awb''. Documents returned from the carrier are always shipping_document. '
          type: integer
          readOnly: false
        is_paperless:
          description: Used to indicate if a shipment is paperless
          type: boolean
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    document_templates:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        copies:
          description: Number of copies
          type: integer
          readOnly: false
        document_type:
          description: Type of document
          type: integer
          readOnly: false
        overrides:
          description: Overrides for the document
          type: string
          readOnly: false
        defaults:
          description: Defaults for the document
          type: string
          readOnly: false
        notify:
          description: Notify
          type: boolean
          readOnly: false
        email_address:
          description: Email address
          type: string
          readOnly: false
        email_body:
          description: Email body
          type: string
          readOnly: false
        email_filename:
          description: Email filename
          type: string
          readOnly: false
    drop_points:
      type: object
      properties:
        drop_point_id:
          description: The carriers ID of the drop point.
          type: string
          readOnly: false
        name:
          description: Name of the drop point
          type: string
          readOnly: false
        address_1:
          description: Address line 1 of the drop point
          type: string
          readOnly: false
        address_2:
          description: Address line 2 of the drop point
          type: string
          readOnly: false
        zip:
          description: Zip code for the drop point
          type: string
          readOnly: false
        city:
          description: City for the drop point
          type: string
          readOnly: false
        country_code:
          description: 'Country Code for the drop point. ISO 3166-1 Alfa 2 '
          type: string
          readOnly: false
        state:
          description: State code. ISO 3166-2 Alfa 2
          type: string
          readOnly: false
        phone:
          description: Phone of the drop point
          type: string
          readOnly: false
        carrier_code:
          description: Text base code to identify the carrier of the drop point (
            not mandatory )
          type: string
          readOnly: false
        routing_code:
          description: Routing code for the drop point.
          type: string
          readOnly: false
        longitude:
          description: Longitude
          type: string
          readOnly: false
        latitude:
          description: Latitude
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        opening_hours:
          description: Opening hours for the drop point. Days are 0-indexed, starting
            with Monday as 0
          type: string
          readOnly: true
    drop_point_locators:
      type: object
      properties:
        carrier_id:
          description: ID of the carrier that you want to quote. <strong>This is only
            mandatory if no shipping_rate_id is given</strong>.
          type: integer
          readOnly: false
        service_code:
          description: Service code for the service that you want to quote. <strong>This
            is only mandatory if no shipping_rate_id is given.</strong>
          type: string
          readOnly: false
        shipping_rate_id:
          description: ID of the shipping rate that you want to quote. <strong>This
            is only mandatory if no carrier_id is given.</strong>.
          type: string
          readOnly: false
        drop_point_id:
          description: ''
          type: string
          readOnly: false
        delivery_address:
          description: Flattened shipping address object. <code>zip</code> and <code>country_code</code>  are
            required and <code>address_1</code> is optional.
          type: string
          readOnly: false
        drop_points:
          description: Array of drop points near delivery_address. This will be populated
            in the response.
          type: array
          readOnly: false
          items:
            "$ref": "#/components/schemas/drop_points"
    edis:
      type: object
      properties:
        status:
          description: Must be one of 'pending', 'on_hold' or 'sent'
          type: integer
          readOnly: false
        data:
          description: The file contents (as text)
          type: string
          readOnly: false
        encoding:
          description: Must be either 'utf8' or 'ascii'
          type: integer
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        carrier_code:
          description: Text-based code representing the carrier type.
          type: string
          readOnly: true
    end_of_day_reports:
      type: object
      properties:
        base64:
          description: Base64 encoding of the PDF document. This must explicitly be
            included with fields[end_of_day_reports]='base64'
          type: string
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        start_time:
          description: Datetime representing the start time for the report
          type: string
          readOnly: false
        end_time:
          description: Datetime representing the end time for the report
          type: string
          readOnly: false
    error_types:
      type: object
      properties:
        translations:
          description: ''
          type: string
          readOnly: false
        matcher:
          description: ''
          type: string
          readOnly: false
        error_class:
          description: ''
          type: string
          readOnly: false
        support_url:
          description: ''
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
    events:
      type: object
      properties:
        title:
          description: ''
          type: string
          readOnly: false
        details:
          description: ''
          type: string
          readOnly: false
        icon:
          description: 'FontAwesome 4 compatible icon like: exclamation, trash, truck,
            envelope, cog, anchor, map-marker, certificate'
          type: string
          readOnly: false
        initiator:
          description: Will be set by the Webshipper API
          type: string
          readOnly: false
        source:
          description: ''
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    event_models:
      type: object
      properties: {}
    favourite_pages:
      type: object
      properties:
        path:
          description: Path of the favourite page
          type: string
          readOnly: false
        name:
          description: Name of the favourite page
          type: string
          readOnly: false
        user_id:
          description: ''
          type: integer
          readOnly: false
    has_documents:
      type: object
      properties: {}
    hot_keys:
      type: object
      properties:
        hot_key:
          description: Key combination of the hotkey
          type: string
          readOnly: false
        path:
          description: Path the hotkey is assigned to
          type: string
          readOnly: false
        favourite_page_id:
          description: ''
          type: integer
          readOnly: false
        user_id:
          description: ''
          type: integer
          readOnly: false
    labels:
      type: object
      properties:
        shipment_id:
          description: ''
          type: integer
          readOnly: false
        label_size:
          description: 'Size of the label. Enum with possible values: ''100X100'',
            ''100X150'', ''100X192'', ''A4''.'
          type: integer
          readOnly: false
        label_format:
          description: 'Label format. Enum with possible values: ''PDF'', ''ZPL''.'
          type: integer
          readOnly: false
        base64:
          description: Base64 encoding of the pdf document. (Can be an array, see
            the description above)
          type: string
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    local_attrs:
      type: object
      properties:
        attr_name:
          description: Visible name of the attribute
          type: string
          readOnly: false
        attr_key:
          description: Key for the attribute. Used by the system to read the correct
            information
          type: string
          readOnly: false
        attr_type:
          description: 'Data type. Must be either of the following: <code>string</code>,
            <code>integer</code> or <code>password</code>'
          type: string
          readOnly: false
        is_required:
          description: Determines if the form should require the attr to be filled
          type: boolean
          readOnly: false
        description:
          description: Help text to describe the attribute
          type: string
          readOnly: false
        requirement_type:
          description: ''
          type: integer
          readOnly: false
        category:
          description: ''
          type: string
          readOnly: false
        priority:
          description: ''
          type: integer
          readOnly: false
        only_visible_on_creation:
          description: Determines if the form should only be visible when connecting
          type: boolean
          readOnly: false
    local_attr_enums:
      type: object
      properties:
        enum_name:
          description: Visible name for the enum
          type: string
          readOnly: false
        enum_value:
          description: Value for the enum
          type: string
          readOnly: false
    mail_template_previews:
      type: object
      properties:
        mail:
          description: ''
          type: string
          readOnly: false
        mail_template:
          description: ''
          type: string
          readOnly: false
        mail_locale:
          description: ''
          type: string
          readOnly: false
        locale:
          description: ''
          type: string
          readOnly: false
        shipment_id:
          description: ''
          type: string
          readOnly: false
        return_id:
          description: ''
          type: string
          readOnly: false
        order_id:
          description: ''
          type: string
          readOnly: false
        brand_id:
          description: ''
          type: string
          readOnly: false
        hook:
          description: ''
          type: string
          readOnly: false
        overrides:
          description: ''
          type: string
          readOnly: false
        lang:
          description: ''
          type: string
          readOnly: false
        defaults:
          description: ''
          type: string
          readOnly: false
        to:
          description: ''
          type: string
          readOnly: false
        whitelisted_languages:
          description: ''
          type: string
          readOnly: false
    mail_templates:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        default_locale:
          description: ''
          type: string
          readOnly: false
        mail_locales:
          description: ''
          type: string
          readOnly: false
        images:
          description: ''
          type: string
          readOnly: false
        purpose:
          description: ''
          type: integer
          readOnly: false
        bcc_mail:
          description: ''
          type: string
          readOnly: false
        is_prebuilt:
          description: ''
          type: boolean
          readOnly: false
        overrides:
          description: ''
          type: string
          readOnly: false
        defaults:
          description: ''
          type: string
          readOnly: false
        hook:
          description: ''
          type: string
          readOnly: false
        whitelisted_languages:
          description: ''
          type: string
          readOnly: false
        used_by_shipping_rates:
          description: ''
          type: string
          readOnly: false
        described:
          description: Encapsulated with new WYSIWYG editor and legacy HTML based
            templates
          type: string
          readOnly: true
        used_by_order_channels:
          description: which order_channels use mail_template. If not used by any,
            it will return empty list
          type: string
          readOnly: true
    order_merges:
      type: object
      properties:
        order_id:
          description: ID of order to merge order lines in to
          type: boolean
          readOnly: false
        orders:
          description: Orders from which to merge order lines from. Orders as nested
            resources
          type: array
          readOnly: false
          items:
            type: string
    pdf_merges:
      type: object
      properties:
        include_labels:
          description: Whether to include labels or not
          type: boolean
          readOnly: false
        include_docs:
          description: 'Whether to include docs or not'' '
          type: boolean
          readOnly: false
        include_slips:
          description: Whether to include slips or not
          type: boolean
          readOnly: false
        force_a4:
          description: Whether to use A4 paper size not
          type: boolean
          readOnly: false
        shipment_ids:
          description: A list of shipment ids to include in the merged pdf
          type: array
          readOnly: false
          items:
            type: string
        order_ids:
          description: A list of order ids to include in the merged pdf
          type: array
          readOnly: false
          items:
            type: string
        url:
          description: ''
          type: string
          readOnly: false
        failed:
          description: ''
          type: boolean
          readOnly: false
    models:
      type: object
      properties: {}
    oauth_access_tokens:
      type: object
      properties:
        scopes:
          description: The scopes to which access is granted by the access token.
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        resource_owner_id:
          description: Id of the owner
          type: integer
          readOnly: false
        expires_in:
          description: Epoch timestamp of the expiration date for the token
          type: integer
          readOnly: false
        expired:
          description: ''
          type: string
          readOnly: false
        token:
          description: The access token
          type: string
          readOnly: false
        revoked_at:
          description: Datetime of the time the token was revoked - if revoked
          type: string
          readOnly: false
        resource_owner:
          description: ''
          type: string
          readOnly: false
        application_id:
          description: ''
          type: integer
          readOnly: false
        application:
          description: The application to which this tokens grants access
          type: string
          readOnly: false
    oauth_applications:
      type: object
      properties:
        name:
          description: Application name
          type: string
          readOnly: false
        uid:
          description: Unique id
          type: string
          readOnly: false
        scopes:
          description: The scopes which the OAuth application will be granted.
          type: string
          readOnly: false
        redirect_uri:
          description: OAuth redirect URI
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
    orders:
      type: object
      properties:
        order_channel_id:
          description: DEPRECATED Assign a relation instead
          type: integer
          readOnly: false
        status:
          description: 'Enum status of the order. Possible values: pending, dispatched,
            partly_dispatched, cancelled, error, missing_rate, on_hold'
          type: string
          readOnly: false
        ext_ref:
          description: External ( hidden ) reference for the order. Used by system
            to update the order in e.g. order channels. Must be unique in scope of
            order channels.
          type: string
          readOnly: false
        visible_ref:
          description: Visible reference - the friendly/visible external order number
          type: string
          readOnly: false
        drop_point:
          description: Flattened resource of type DropPoint. Must be assigned when
            the order must be delivered to a drop point.
          readOnly: false
          "$ref": "#/components/schemas/drop_points"
        original_shipping:
          description: Flattened resource describing the original shipping option
            from the order channel. This will be used for matching in cases where
            shipping was not quoted from Webshipper.
          type: object
          readOnly: false
        order_lines:
          description: Flattened resource of type OrderLine
          type: array
          readOnly: false
          items:
            "$ref": "#/components/schemas/order_lines"
        delivery_address:
          description: Flattened resource of type ShippingAddress
          readOnly: false
          "$ref": "#/components/schemas/shipping_addresses"
        sender_address:
          description: Flattened resource of type ShippingAddress. If the address
            is not assigned - the sender address of the order channel will be used.
          readOnly: false
          "$ref": "#/components/schemas/shipping_addresses"
        billing_address:
          description: Flattened resource of type ShippingAddress. Will be duplicated
            from delivery address if not assigned.
          readOnly: false
          "$ref": "#/components/schemas/shipping_addresses"
        sold_from_address:
          description: Flattened resource of type ShippingAddress. Will be duplicated
            from sender address if not assigned.
          readOnly: false
          "$ref": "#/components/schemas/shipping_addresses"
        currency:
          description: Currency code of the order
          type: string
          readOnly: false
        internal_comment:
          description: DEPRECATED Please use the Comments model instead
          type: string
          readOnly: false
        external_comment:
          description: DEPRECATED Please use the Comments model instead
          type: string
          readOnly: false
        error_message:
          description: Any error message that resulted from the latest attempt at
            making a shipment from the order.
          type: object
          readOnly: false
        slip:
          description: The order slip in PDF format using base64 encoding. This will
            only be included if the parameter fields[orders] includes slip.
          type: string
          readOnly: true
        base64:
          description: ''
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        lock_state:
          description: 'When an order is locked, it cannot be modified or sent until
            it is unlocked. Possible values: <code>locked</code> or <code>unlocked</code>.'
          type: string
          readOnly: false
        source:
          description: 'A description of how the order was created in Webshipper.
            Possible values: ''api'', ''manual'' or ''csv'''
          type: string
          readOnly: false
        tags:
          description: Array of strings used to tag an order
          type: array
          readOnly: false
          items:
            type: string
        error_class:
          description: A string like 'address' or 'carrier_downtime' describe which
            type of error caused the order to fail
          type: string
          readOnly: false
        slip_printed:
          description: ''
          type: boolean
          readOnly: false
        label_printed:
          description: ''
          type: boolean
          readOnly: false
        create_shipment_automatically:
          description: ''
          type: string
          readOnly: false
        latest_activity:
          description: ''
          type: string
          readOnly: false
        latest_status_event:
          description: ''
          type: string
          readOnly: false
        shipping_rate_id:
          description: ''
          type: integer
          readOnly: false
        csv_upload_id:
          description: ''
          type: integer
          readOnly: false
    order_channels:
      type: object
      properties:
        channel_label:
          description: Label to identify the order channel.
          type: string
          readOnly: false
        attrs:
          description: |-
            Array of hashed with keys: <code>attr_key</code>, <code>attr_value</code>, <code>attr_name</code>, <code>attr_type</code>, <code>is_required</code>, <code>only_visible_on_creation</code> </code>enums</code>. See
                  documentation for Local Attributes
          type: array
          readOnly: false
          items:
            type: string
        additional_parameters:
          description: Optional hash, this is used when creating new order channels.
          type: object
          readOnly: false
        slip_print_mode:
          description: 'Possible values: ''dont_print'', ''print_immediately'' or
            ''print_with_shipment''.'
          type: string
          readOnly: false
        return_label_print_mode:
          description: 'Possible values: ''dont_print'', ''print_immediately''.'
          type: string
          readOnly: false
        shipping_label_print_mode:
          description: 'Possible values: ''dont_print'', ''print_immediately''.'
          type: string
          readOnly: false
        document_print_mode:
          description: 'Possible values: ''dont_print'', ''print_immediately''.'
          type: string
          readOnly: false
        logo:
          description: Base64 representation of the logo of the order channel.
          type: string
          readOnly: false
        configuration_token:
          description: Token to use for Webshipper modules. Tokens will only be generated
            for modules that require a configuration token.
          type: string
          readOnly: false
        sync_status:
          description: 'Determines if the order channel is currently synchronising.
            Possible values are: <code>synchronize</code>, <code>suspended</code>,
            <code>paused</code>.'
          type: integer
          readOnly: false
        failed_sync_count:
          description: Shows if recent synchronisation events have failed.
          type: integer
          readOnly: false
        fulfill_automatically:
          description: 'Whether or not to fulfill the order in the original order
            channel when a shipment is created. Default: true'
          type: boolean
          readOnly: false
        drop_point_limit:
          description: ''
          type: integer
          readOnly: false
        create_shipment_automatically:
          description: ''
          type: boolean
          readOnly: false
        health:
          description: ''
          type: string
          readOnly: false
        convert_currency_on_rate_quotes:
          description: ''
          type: boolean
          readOnly: false
        sync_additional_attributes_to_shipments:
          description: ''
          type: boolean
          readOnly: false
        auto_order_import:
          description: ''
          type: boolean
          readOnly: false
        has_configuration_token:
          description: ''
          type: string
          readOnly: false
    order_channel_accesses:
      type: object
      properties:
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
    order_channel_types:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        support_url:
          description: ''
          type: string
          readOnly: false
        public_global_attrs:
          description: ''
          type: string
          readOnly: false
        list_logo:
          description: ''
          type: string
          readOnly: false
        description:
          description: ''
          type: string
          readOnly: false
        module_link:
          description: ''
          type: string
          readOnly: false
        can_autofulfill:
          description: ''
          type: boolean
          readOnly: false
        can_limit_drop_points:
          description: ''
          type: boolean
          readOnly: false
        supports_rate_quoting:
          description: ''
          type: boolean
          readOnly: false
        uses_scheduled_import:
          description: ''
          type: boolean
          readOnly: false
        supports_time_interval_import:
          description: ''
          type: boolean
          readOnly: false
        supports_statuses_import:
          description: ''
          type: boolean
          readOnly: false
        supports_id_import:
          description: ''
          type: boolean
          readOnly: false
        supports_vat_in_checkout:
          description: ''
          type: boolean
          readOnly: false
        hide:
          description: ''
          type: boolean
          readOnly: false
    order_lines:
      type: object
      properties:
        sku:
          description: Stock Keeping Unit of the order line
          type: string
          readOnly: false
        description:
          description: Description of the goods
          type: string
          readOnly: false
        quantity:
          description: Quantity of goods
          type: integer
          readOnly: false
        location:
          description: The warehouse location of the items.
          type: string
          readOnly: false
        tarif_number:
          description: HS Tarif code for paperless customs
          type: string
          readOnly: false
        country_of_origin:
          description: The country of origin of the goods.
          type: string
          readOnly: false
        unit_price:
          description: The unit price of goods in the currency of the order
          type: number
          readOnly: false
        package_id:
          description: Whether the items are associated with a parcel of a shipment.
          type: integer
          readOnly: false
        discounted_unit_price:
          description: The unit price after discounts has been applied in the currency
            of the order
          type: string
          readOnly: false
        discount_value:
          description: The discount for the order line, in the type given by discount_type
          type: number
          readOnly: false
        discount_type:
          description: The type of discount, eg. percent or fixed
          type: integer
          readOnly: false
        vat_percent:
          description: The VAT rate in percentage.
          type: number
          readOnly: false
        order_id:
          description: ''
          type: integer
          readOnly: false
        status:
          description: 'Possible enum values: pending, dispatched or returned'
          type: integer
          readOnly: false
        ext_ref:
          description: External reference of the order line.
          type: string
          readOnly: false
        weight:
          description: Weight per unit.
          type: number
          readOnly: false
        weight_unit:
          description: 'Weight unit. Possible values: <code>oz</code>, <code>g</code>,
            <code>lbs</code>, <code>kg</code>. Defaults to <code>g</code>'
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        is_virtual:
          description: ''
          type: boolean
          readOnly: false
        dangerous_goods_details:
          description: 'Optional object of key value pairs used for providing information
            of dangerous goods. For use with DGOffice, use keys: article_no, package_type_id
            and packaging_instruction_type.'
          type: object
          readOnly: false
    packages:
      type: object
      properties:
        weight:
          description: Weight of the package
          type: number
          readOnly: false
        weight_unit:
          description: 'One of ''g'', ''oz'', ''lbs'' and ''kg'' '
          type: string
          readOnly: false
          enum:
          - g
          - oz
          - lbs
          - kg
        dimensions:
          description: ''
          type: string
          readOnly: false
        service_attributes:
          description: ''
          type: string
          readOnly: false
        add_ons:
          description: ''
          type: string
          readOnly: false
        colli_type:
          description: Colli type of the package. Can be used to specify if the colli
            is a pallet, package, letter, etc. Should use values from the supported_colli_types
            field from the service quote/list response for the given service.
          type: string
          readOnly: false
        predefined_barcode:
          description: A predefined SSCC barcode. Can be used if the barcode already
            has been created outside of Webshipper.
          type: string
          readOnly: false
    pickups:
      type: object
      properties:
        pickup_instruction:
          description: Instruction to the carrier.
          type: string
          readOnly: false
        pickup_location_close_time:
          description: When the pickup location is closing.
          type: string
          readOnly: false
        pickup_time:
          description: The time you want the carrier to arrive at the pickup address.
          type: string
          readOnly: false
        reference:
          description: The reference returned by the carrier.
          type: string
          readOnly: false
        status:
          description: 'Decides if the pickup is <code>requested</code> or <code>cancelled</code>.
            To cancel a pickup you must update the status to cancelled. '
          type: integer
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        shipping_address:
          description: The address where the shipments must be picked up.
          type: string
          readOnly: false
        carrier:
          description: The carrier that should pickup the shipments.
          type: string
          readOnly: false
    bulk_printer_jobs:
      type: object
      properties:
        ids:
          description: ''
          type: string
          readOnly: false
        model_type:
          description: ''
          type: string
          readOnly: false
        printer_client_id:
          description: ''
          type: string
          readOnly: false
    printables:
      type: object
      properties: {}
    printers:
      type: object
      properties:
        name:
          description: Name of the printer.
          type: string
          readOnly: false
        active:
          description: Determines if the printer is configured on the printer station
          type: boolean
          readOnly: false
        last_connected:
          description: Last connection time
          type: string
          readOnly: false
        paper_width:
          description: Paper width
          type: number
          readOnly: false
        paper_height:
          description: Paper height
          type: number
          readOnly: false
        rotate_print_180:
          description: ''
          type: boolean
          readOnly: false
    printer_clients:
      type: object
      properties:
        uuid:
          description: Unique ID of the printer client
          type: string
          readOnly: false
        approved:
          description: DEPRECATED
          type: boolean
          readOnly: false
        alias:
          description: 'Defaults to the host name of the machine running the client '
          type: string
          readOnly: false
        is_online:
          description: Shows if the printer client is online
          type: boolean
          readOnly: false
        last_connected:
          description: Shows when the printer client was last connected
          type: string
          readOnly: false
        prevent_multiple_shipments:
          description: ''
          type: boolean
          readOnly: false
    printer_jobs:
      type: object
      properties:
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        completed:
          description: This will return as <code>true</code> when the printer client
            has accepted the job.
          type: boolean
          readOnly: false
        error:
          description: Any error message that resulted.
          type: string
          readOnly: false
        base64:
          description: Base64 encoding if the associated printable, must the explicitly
            included in <em>fields</em> query parameter to be included
          type: string
          readOnly: true
        try_count:
          description: ''
          type: integer
          readOnly: false
        initiator:
          description: ''
          type: string
          readOnly: false
        options:
          description: ''
          type: string
          readOnly: false
    rate_quotes_items:
      type: object
      properties:
        price:
          description: Price in some currency
          type: string
          readOnly: true
    rate_quotes:
      type: object
      properties:
        quotes:
          description: Array of quotes
          type: array
          readOnly: true
          items:
            "$ref": "#/components/schemas/rate_quotes_items"
        success:
          description: DEPRECATED. The request will return an error response if the
            quote failed.
          type: string
          readOnly: true
        delivery_address:
          description: Delivery address for the quote. Flattened resource of 'Shipping
            Address'
          type: object
          readOnly: false
        price:
          description: The total price of the items
          type: integer
          readOnly: false
        weight:
          description: Weight for the quote.
          type: number
          readOnly: false
        weight_unit:
          description: 'The weight unit. Possible values: g, kg, lbs, oz.'
          type: string
          readOnly: false
          enum:
          - g
          - kg
          - lbs
          - oz
        height:
          description: Height for the quote. The unit must match the unit you are
            using for shipping rate configurations.
          type: number
          readOnly: false
        length:
          description: Length for the quote. The unit must match the unit you are
            using for shipping rate configurations.
          type: number
          readOnly: false
        width:
          description: Width for the quote. The unit must match the unit you are using
            for shipping rate configurations.
          type: number
          readOnly: false
        dimensions_unit:
          description: 'Dimensions unit. Possible values: cm, m, in, ft'
          type: string
          readOnly: false
        sender_address:
          description: Delivery address for the quote. Flattened resource of 'Shipping
            Address'
          type: object
          readOnly: false
        items:
          description: Array of items, each item should have fields <code>quantity</code>,
            <code>sku</code>, <code>description</code>
          type: array
          readOnly: false
          items:
            type: object
            properties:
              quantity:
                type: string
              sku:
                type: string
              description:
                type: string
        order_channel_id:
          description: The id of the order channel for which to get shipping rates.
          type: integer
          readOnly: false
        currency:
          description: ''
          type: string
          readOnly: false
        include_hidden:
          description: Also include shipping rates which are normally hidden during
            checkout.
          type: boolean
          readOnly: false
        is_return:
          description: 'Set to true to quote for return rates. If false standard rates
            are quoted. Default: false.'
          type: boolean
          readOnly: false
        additional_attributes:
          description: Possibility to add hash of additional attributes for filtering.
          type: string
          readOnly: false
        filter_by_currency:
          description: ''
          type: string
          readOnly: false
    reports:
      type: object
      properties:
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        start_time:
          description: ''
          type: string
          readOnly: false
        end_time:
          description: ''
          type: string
          readOnly: false
        output_formats:
          description: ''
          type: array
          readOnly: false
          items:
            type: string
        parameters:
          description: ''
          type: object
          readOnly: false
        base64:
          description: ''
          type: string
          readOnly: true
        pdf_download_url:
          description: ''
          type: string
          readOnly: false
        xml_download_url:
          description: ''
          type: string
          readOnly: false
        csv_download_url:
          description: ''
          type: string
          readOnly: false
        json_download_url:
          description: ''
          type: string
          readOnly: false
        xlsx_download_url:
          description: ''
          type: string
          readOnly: false
        failed:
          description: ''
          type: boolean
          readOnly: false
        order_ids:
          description: ''
          type: string
          readOnly: false
        error_message:
          description: ''
          type: string
          readOnly: false
    report_types:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        columns:
          description: Array of objects with keys <code>header</code> and <code>content</code>
          type: array
          readOnly: false
          items:
            type: string
        parameters:
          description: Array of objects with keys <code>parameter_key</code> and <code>parameter_value</code>
          type: array
          readOnly: false
          items:
            type: string
        resource:
          description: ''
          type: string
          readOnly: false
        header_columns:
          description: Array of objects with keys <code>header</code> and <code>content</code>
            that will be used to display the header content of the report
          type: array
          readOnly: false
          items:
            type: string
        footer_content:
          description: ''
          type: string
          readOnly: false
        conditions:
          description: Array of objects describing how to load the resources. Contains
            keys <code>condition_key</code>, <code>condition_operator</code>, <code>condition_value</code>.
          type: array
          readOnly: false
          items:
            type: string
        include_deleted:
          description: 'If true the report will included deleted records. Default:
            <code>false</code>'
          type: boolean
          readOnly: false
        use_carrier_eod:
          description: When set to true it will attempt to fetch the end of day list
            directly from the carrier. When this option is enabled, only pdf reports
            are available.
          type: boolean
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        schedule:
          description: ''
          type: string
          readOnly: false
        default_format:
          description: ''
          type: string
          readOnly: false
        mail_on_run:
          description: ''
          type: boolean
          readOnly: false
        mail:
          description: ''
          type: string
          readOnly: false
    printer_requeue_jobs:
      type: object
      properties:
        start_time:
          description: ''
          type: string
          readOnly: false
        end_time:
          description: ''
          type: string
          readOnly: false
        job_id:
          description: ''
          type: string
          readOnly: false
        mark_as_complete:
          description: ''
          type: string
          readOnly: false
    return_causes:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        description:
          description: ''
          type: string
          readOnly: false
        require_comment:
          description: Does the cause require a comment
          type: boolean
          readOnly: false
        limit_refund_methods:
          description: Does the cause limit refund methods
          type: boolean
          readOnly: false
        support_image_required:
          description: Does the cause support image required
          type: boolean
          readOnly: false
    return_lines:
      type: object
      properties:
        cause_description:
          description: Description of the cause
          type: string
          readOnly: false
        quantity:
          description: Quantity of the return line
          type: integer
          readOnly: false
        refund_method:
          description: Refund method for the return line
          type: string
          readOnly: false
    returns:
      type: object
      properties:
        status:
          description: One of pending, sent, arrived, processed, error or approved
          type: string
          readOnly: false
        error_message:
          description: ''
          type: string
          readOnly: false
        return_lines:
          description: 'Array of ReturnLine objects. Contains fields order_line_id,
            quantity, cause_id, cause_description and images. When creating, images
            should be an array of data uri containing the base64 encoding of the image,
            example: <em>data:image/jpeg;base64,AAQSkZJ......RgABAQEAlgCWAAD</em>'
          type: array
          readOnly: false
          items:
            type: string
        base64:
          description: Base 64 encoding of return slip
          type: string
          readOnly: false
        secret:
          description: Read only token for publicly accessing status of the return
            order
          type: string
          readOnly: true
        internal_comment:
          description: ''
          type: string
          readOnly: false
        latest_activity:
          description: ''
          type: string
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        order_channel_id:
          description: ''
          type: integer
          readOnly: false
        internal_session_id:
          description: ''
          type: string
          readOnly: false
    return_portals:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        custom_style:
          description: ''
          type: string
          readOnly: false
        shipping_methods:
          description: ''
          type: string
          readOnly: false
        translations:
          description: ''
          type: string
          readOnly: false
        locale:
          description: ''
          type: string
          readOnly: false
        allowed_days_since_dispatch:
          description: ''
          type: integer
          readOnly: false
        send_immediately:
          description: ''
          type: boolean
          readOnly: false
        static_notice_email:
          description: ''
          type: string
          readOnly: false
        order_channel_logo:
          description: ''
          type: string
          readOnly: false
        logo:
          description: ''
          type: string
          readOnly: false
        force_single_page:
          description: ''
          type: boolean
          readOnly: false
        order_channel_id:
          description: ''
          type: integer
          readOnly: false
        optional_return_cause:
          description: ''
          type: boolean
          readOnly: false
        new_mail_template:
          description: ''
          type: string
          readOnly: false
        new_confirmation_mail_template:
          description: ''
          type: string
          readOnly: false
        email_address_source:
          description: ''
          type: integer
          readOnly: false
        email_address_resource_options:
          description: ''
          type: string
          readOnly: false
        finished_stripe_setup:
          description: ''
          type: string
          readOnly: false
    return_shipping_methods:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        excluded_skus:
          description: ''
          type: string
          readOnly: false
        excluded_zip_codes:
          description: ''
          type: string
          readOnly: false
        excluded_countries:
          description: ''
          type: string
          readOnly: false
    service_quotes:
      type: object
      properties:
        success:
          description: True if quote was successful
          type: boolean
          readOnly: true
        carrier_id:
          description: The id of the carrier to quote
          type: integer
          readOnly: false
        service_code:
          description: Service code of the carrier. This is optional. When omitted,
            all supported services will be returned.
          type: string
          readOnly: false
        send_time:
          description: ISO 8601 formatted
          type: string
          readOnly: false
        send_date:
          description: ''
          type: string
          readOnly: false
        packages:
          description: Array of objects, each containing key <code>weight</code>.
            At least one package is required.
          type: array
          readOnly: false
          items:
            type: string
        delivery_address:
          description: Delivery address for the quote
          type: object
          readOnly: false
        sender_address:
          description: Sender address for the quote
          type: object
          readOnly: false
        services:
          description: |-
            Read only. Populated in response with an array of objects containing the following keys: <ul class='list-doc'>
             <li><code>service_name</code></li>
             <li><code>service_code</code></li>
             <li><code>is_return</code></li>
               <li><code>supports_paperless</code></li>
               <li><code>requires_drop_point</code></li>
               <li><code>cost_price</code></li>
               <li><code>currency</code></li>
               <li><code>vat_percent</code></li>
               <li><code>estimated_delivery_date_from</code></li>
               <li><code>estimated_delivery_date_to</code></li>
               <li>

              <code>add_ons</code>
            <div class='text-muted'>Array containing objects</div>
              <ul class='list-doc'>
                <li><code>add_on_name</code></li>
                <li><code>add_on_code</code></li>
              </ul>
            </li>
               <li><code>parameters</code></li>
            <div class='text-muted'>Array containing objects</div>
               <ul class='list-doc'>
                <li><code>attr_name</code></li>
                <li><code>attr_key</code></li>
                <li><code>attr_type</code></li>
               </ul>
               <li><code>country_combinations</code></li>
               <li><code>barcode_requirement</code></li>
               <li><code>waybill_requirement</code></li>
               <li><code>booking_quote_info</code></li>
               <li><code>supported_colli_types</code></li>

            </ul>
          type: array
          readOnly: true
          items:
            type: string
        add_ons:
          description: Carrier add-ons for the quote
          type: string
          readOnly: false
        service_attributes:
          description: Service attributes for the carrier
          type: string
          readOnly: false
        is_return:
          description: Determines if you are quoting for return (inbound) services
            or standard (outbound) services.
          type: string
          readOnly: false
        dutiable:
          description: Determines if the goods for the quote are dutiable
          type: string
          readOnly: false
        cost_sheet_id:
          description: Used if you want only a price from a specific cost sheet
          type: string
          readOnly: false
        timeout:
          description: Timeout for request in seconds. Will default to 15 seconds
          type: string
          readOnly: false
    shipments:
      type: object
      properties:
        reference:
          description: The reference you want to identify the shipment form. For example
            order number.
          type: string
          readOnly: false
        comment:
          description: An optional comment for the carrier
          type: string
          readOnly: false
        service_code:
          description: The carrier's service code. This should only be assigned if
            you are not using a shipping rate.
          type: string
          readOnly: false
        is_return:
          description: Determines whether the shipment is a return shipment.
          type: boolean
          readOnly: false
        packages:
          description: Flattened array of packages to be sent. At least one package
            is mandatory. For structure refer to 'Package' entity
          type: array
          readOnly: false
          items:
            "$ref": "#/components/schemas/packages"
        delivery_address:
          description: Flattened Shipping Address representing the delivery address
            for the shipment. <br><strong>Duplicated from order if order relation
            given.</strong>.
          type: object
          readOnly: false
        sender_address:
          description: Flattened Shipping Address representing the sender address
            of shipment. <br><strong>Duplicated from order if order relation given.</strong>.
          type: object
          readOnly: false
        billing_address:
          description: Flattened Shipping Address representing the billing address
            of shipment. Duplicated from delivery address if empty. <br><strong>Duplicated
            from order if order relation given.</strong>.
          type: object
          readOnly: false
        sold_from_address:
          description: ''
          type: string
          readOnly: false
        pickup_address:
          description: Flattened Shipping Address representing the pickup address
            of shipment. Is necessary for some carriers. This is duplicated from sender
            address if empty. <br><strong>Duplicated from order if order relation
            given.</strong>.
          type: object
          readOnly: false
        return_address:
          description: Flattened Shipping Address represnting return addres of shipment.
            Will be duplicated from sender address if empty ( Not used by all carriers
            ). <br><strong>Duplicated from order if order relation given.</strong>.
          type: object
          readOnly: false
        service_attributes:
          description: |-
            Array of hashes to assign parameters for any specific carrier service. It is only required if you are <strong>not</strong> using shipping rates and the service has additional required parameters. The hash must have the keys attr_key and attr_value. The type of attr_value should match the attr_type defined by the parameter. To see all possible attributes, please see the list of parameters from the carrier service.
            <strongShould only be assigned if you are not using a shipping rate</strong>.
          type: array
          readOnly: false
          items:
            type: string
        add_ons:
          description: |-
            Array of add-ons. Add-ons are simply arrays of strings. To see possible add-ons, please refer to the carrier services.
            <strong>Should only be assigned if you are not using a shipping rate</strong>.
          type: array
          readOnly: false
          items:
            type: string
        sms_notification:
          description: |-
            Must be passed if the carrier should be allowed to send SMS notifications. It should be assigned with a hash including the key phone containing the phone number to be notified.
            <strong>Should only be assigned if you are not using a shipping rate</strong>.
          type: string
          readOnly: false
        email_notification:
          description: |-
            Must be passed if the carrier should be allowed to send e-mail notifications. It should be assigned with a hash including the key email containing the e-mail address to be notified.
            <strong>Should only be assigned if you are not using a shipping rate</strong>.
          type: string
          readOnly: false
        included_documents:
          description: Flattened array of Document - can be used to upload documents
            to the shipment which will be sent to the carrier.
          type: string
          readOnly: false
        drop_point:
          description: Flattened Drop Point - should only be assigned if you are sending
            to a drop point.
          type: string
          readOnly: false
        tracking_links:
          description: "An array of objects with the keys:\n      <ul>\n        <li><code>url</code>:
            The full URL to the tracking page.</li>\n        <li><code>number</code>:
            The tracking identifier.</li>\n        <li><code>latest_transit_event</code>:
            The latest tracking/transit event. Same options as Tracking Event statuses.</li>\n
            \       <li><code>tracking_events</code>: Array of objects. Object has
            same attributes as the Tracking Event resource</li>\n      </ul>\n      "
          type: array
          readOnly: false
          items:
            type: object
            properties:
              url:
                type: string
              number:
                type: string
              latest_transit_event:
                type: string
              tracking_events:
                type: string
        fulfill_immediately:
          description: Deprecated
          type: string
          readOnly: false
        test_mode:
          description: ''
          type: boolean
          readOnly: false
        dutiable:
          description: ''
          type: boolean
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        ext_ref:
          description: The external (carrier) reference
          type: string
          readOnly: false
        original_shipment_id:
          description: ''
          type: integer
          readOnly: false
        send_time:
          description: ''
          type: string
          readOnly: false
        status:
          description: ''
          type: integer
          readOnly: false
        latest_update_time:
          description: ''
          type: string
          readOnly: false
        supports_updates:
          description: ''
          type: string
          readOnly: false
        additional_attributes:
          description: Flattened hash with optional key/value pairs.
          type: string
          readOnly: false
        cost_price:
          description: The cost price of the shipment, either directly from the carrier
            or from a cost sheet
          type: number
          readOnly: false
        sales_price:
          description: The price presented to the customer in checkout
          type: number
          readOnly: false
        currency:
          description: ''
          type: string
          readOnly: false
        manual_order_shipment_creation:
          description: ''
          type: string
          readOnly: false
        carrier_type_name:
          description: Webshipper defined name of the carrier type
          type: string
          readOnly: true
        carrier_alias:
          description: Carrier alias set by the user in Webshipper
          type: string
          readOnly: true
        carrier_id:
          description: ID of the carrier
          type: integer
          readOnly: true
        invoice_settings:
          description: ''
          type: string
          readOnly: false
        latest_activity:
          description: ''
          type: string
          readOnly: false
        latest_status_event:
          description: ''
          type: string
          readOnly: false
        shadow_booking_as_parent:
          description: ''
          type: string
          readOnly: false
        source:
          description: ''
          type: integer
          readOnly: false
        document_template:
          description: ''
          type: string
          readOnly: false
        csv_upload_id:
          description: ''
          type: integer
          readOnly: false
        omit_print:
          description: ''
          type: boolean
          readOnly: false
        original_shipment:
          description: An optional link to the original shipment, when creating a
            return-shipment
          type: string
          readOnly: false
    shipping_addresses:
      type: object
      properties:
        att_contact:
          description: Att person. To generate parcels either att_contact <strong>or</strong>
            company_name is required
          type: string
          readOnly: false
        company_name:
          description: Company name. To generate parcels either att_contact <strong>or</strong>
            company_name is required
          type: string
          readOnly: false
        address_1:
          description: Address line 1
          type: string
          readOnly: false
        address_2:
          description: Address line 2
          type: string
          readOnly: false
        country_code:
          description: ISO 3166-1 alpha-2 code
          type: string
          readOnly: false
        state:
          description: Sub-division of country, if applicable. State code. ISO 3166-2
            alpha-2
          type: string
          readOnly: false
        phone:
          description: Phone number of the entity. This can be used for SMS notifications.
          type: string
          readOnly: false
        email:
          description: E-mail address of the entity. This can be used for e-mail notifications.
          type: string
          readOnly: false
        zip:
          description: Postal code of the entity. This is required for most destination
            countries.
          type: string
          readOnly: false
        city:
          description: City of the entity. This is required for most destination countries.
          type: string
          readOnly: false
        vat_no:
          description: The VAT number of the entity. This is only required for address_type
            <code>sold_from</code>
          type: string
          readOnly: false
        address_type:
          description: 'Used for special addresses for order channels. This will be
            one of the following: <code>recipient</code>, <code>sender</code>, <code>sold_from</code>,
            <code>pickup</code>, <code>return</code>, <code>order_address</code>'
          type: string
          readOnly: false
        ext_location:
          description: ''
          type: string
          readOnly: false
        voec:
          description: ''
          type: string
          readOnly: false
        eori:
          description: ''
          type: string
          readOnly: false
        sprn:
          description: ''
          type: string
          readOnly: false
        ioss:
          description: ''
          type: string
          readOnly: false
        fda:
          description: ''
          type: string
          readOnly: false
        duns:
          description: ''
          type: string
          readOnly: false
        personal_customs_no:
          description: ''
          type: string
          readOnly: false
        company_customs_numbers:
          description: ''
          type: string
          readOnly: false
    shipping_mappings:
      type: object
      properties:
        shipping_code:
          description: Shipping code is a unique identifier from the order channel
            that will be mapped to a shipping rate
          type: string
          readOnly: false
        shipping_name:
          description: Shipping name is a human readable identifier of the shipping
            method
          type: string
          readOnly: false
        shipping_rate_id:
          description: Shipping rate id is the id of the shipping rate which you want
            to map to.
          type: integer
          readOnly: false
        order_channel_id:
          description: Order channel id of the order channel
          type: integer
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
    shipping_rates:
      type: object
      properties:
        carrier_id:
          description: Id of the carrier which the shipping rate belongs to
          type: integer
          readOnly: true
        order_channel_id:
          description: Id of the order channel which the shipping rate belongs to
          type: integer
          readOnly: true
        name:
          description: Name to be displayed in the e-commerce system.
          type: string
          readOnly: false
        carrier_service_code:
          description: The carrier's service code which must be used when generating
            parcels with this shipping rate.
          type: string
          readOnly: false
        require_drop_point:
          description: Determines if the shipping rate requires a drop point to be
            assigned.
          type: boolean
          readOnly: false
        visible_for:
          description: 'Enum - determines whether the rate is returned for all customers,
            private_customers or business customers. This must be one of the following
            values:  <code>any</code>, <code>privat_customers</code>, <code>business_customers</code>'
          type: integer
          readOnly: false
        service_attributes:
          description: 'Array of flattened resources of type <code>Service Attribute</code>.
            Depends on the carrier service''s requirements. Service Attribute has
            the following attributes:  <code>attr_key</code>, <code>attr_value</code>.
            You may use the Webshipper Template Language (WTL) for the values.'
          type: string
          readOnly: false
        dimensions:
          description: 'Predefined dimensions which are a assigned when using the
            shipping rate. Attributes are: <code>height</code>,<code>width</code>
            and <code>length</code>. The Webshipper Template Language (WTL) may be
            used for the values.'
          type: string
          readOnly: false
        add_ons:
          description: Array of add_ons supported by the carrier service.
          type: string
          readOnly: false
        is_return:
          description: Defines whether the rate is a return (inbound) rate or a standard
            rate (outbound). Please be aware that this attribute must match the carrier's
            service type.
          type: boolean
          readOnly: false
        carriers_email:
          description: When this is set to true, the shipping rate will enable e-mail
            notifications from the carrier.
          type: boolean
          readOnly: false
        comment_map:
          description: 'Defines what content is included in the comment field. The
            Webshipper Template Language (WTL) may be used in this field. For example:  {{order.external_comment}}'
          type: string
          readOnly: false
        reference_map:
          description: 'Defines what content is included in the reference field. The
            Webshipper Template Language (WTL) may be used in this field. For example:
            {{order.visible_ref}}'
          type: string
          readOnly: false
        carriers_sms:
          description: When this is set to true, the shipping rate will enable SMS
            notifications from the carrier.
          type: boolean
          readOnly: false
        dutiable:
          description: Defines whether the goods sent using this shipping rate are
            dutiable.
          type: boolean
          readOnly: false
        is_hidden:
          description: Attribute to indicate if the shipping rate is visible to order
            channels
          type: boolean
          readOnly: false
        click_collect:
          description: ''
          type: boolean
          readOnly: false
        reference:
          description: ''
          type: string
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        default_colli_type:
          description: Predefined colli type to be used when using the shipping rate.
            Must be supported by the carrier.
          type: string
          readOnly: false
        sender_address_id:
          description: ''
          type: integer
          readOnly: false
        return_address_id:
          description: ''
          type: integer
          readOnly: false
        invoice_settings:
          description: ''
          type: string
          readOnly: false
        shadow_booking_keep_labels:
          description: ''
          type: boolean
          readOnly: false
        shadow_booking_keep_documents:
          description: ''
          type: boolean
          readOnly: false
        ignore_rate_quote_validation:
          description: ''
          type: boolean
          readOnly: false
        custom_message:
          description: Custom message to be displayed for the shipping rate
          type: string
          readOnly: false
        regions:
          description: Flattended array of Regions. See section on Shipping Regions
            and Expressions for more details
          type: string
          readOnly: false
    expressions:
      type: object
      properties:
        expression:
          description: Is the actual WEL expression to be evaluated
          type: string
          readOnly: false
        vat_percent:
          description: VAT rate in percentage which must be added to the price.
          type: number
          readOnly: false
        currency:
          description: Currency of the price
          type: string
          readOnly: false
        price:
          description: The cost price displayed to the end user
          type: number
          readOnly: false
    regions:
      type: object
      properties:
        name:
          description: Name
          type: string
          readOnly: false
        expressions:
          description: Flattened array of expressions. Please see section 8 for more
            details regarding expressions.
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        countries:
          description: ''
          type: string
          readOnly: false
    slip_templates:
      type: object
      properties:
        name:
          description: Name to identify the template.
          type: string
          readOnly: false
        slip_size:
          description: 'Size of the parcel slip. Possible values: <code>A4</code>
            and <code>4X6</code>'
          type: integer
          readOnly: false
        additional_content:
          description: Content after the table of order lines for A4-based parcel
            slips.
          type: string
          readOnly: false
        additional_content_align:
          description: 'Alignment of additional_content. Possible values: <code>center</code>,
            <code>right</code>, <code>left</code>'
          type: integer
          readOnly: false
        barcode_content:
          description: Content of the barcode
          type: string
          readOnly: false
        header_content:
          description: Content of the slip header
          type: string
          readOnly: false
        top_left_content_header:
          description: Header of the top left corner
          type: string
          readOnly: false
        top_right_content_header:
          description: Header of the top right corner
          type: string
          readOnly: false
        top_left_content:
          description: Content of the top left corner
          type: string
          readOnly: false
        top_right_content:
          description: Content of the top right corner
          type: string
          readOnly: false
        footer_content:
          description: Content of the footer
          type: string
          readOnly: false
        slip_template_columns:
          description: 'Array of columns. Column objects contains: <code>name</code><code>content</code>,
            <code>text_alignment</code>(right, left, center), <code>width</code> (in
            percentage)'
          type: string
          readOnly: false
        table_color:
          description: 'HEX color including #'
          type: string
          readOnly: false
        table_text_color:
          description: 'HEX color including #'
          type: string
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        sort_key:
          description: The key to sort the order-lines by
          type: string
          readOnly: false
        returns_only:
          description: ''
          type: boolean
          readOnly: false
        disable_inline_formatting:
          description: ''
          type: boolean
          readOnly: false
        used_by_order_channels:
          description: which order_channels use slip_template. If not used by any,
            it will return empty list
          type: string
          readOnly: false
    slip_template_previews:
      type: object
      properties:
        slip_template:
          description: ''
          type: string
          readOnly: false
        order_visible_ref:
          description: ''
          type: string
          readOnly: false
        base64:
          description: ''
          type: string
          readOnly: false
        example_id:
          description: ''
          type: string
          readOnly: false
    stores:
      type: object
      properties:
        name:
          description: ''
          type: string
          readOnly: false
        address_1:
          description: ''
          type: string
          readOnly: false
        address_2:
          description: ''
          type: string
          readOnly: false
        zip:
          description: ''
          type: string
          readOnly: false
        city:
          description: ''
          type: string
          readOnly: false
        state:
          description: ''
          type: string
          readOnly: false
        country_code:
          description: ''
          type: string
          readOnly: false
        longitude:
          description: ''
          type: string
          readOnly: false
        latitude:
          description: ''
          type: string
          readOnly: false
    tags:
      type: object
      properties:
        tag:
          description: ''
          type: string
          readOnly: true
    tracking_events:
      type: object
      properties:
        status:
          description: One of <em>information_received</em>, <em>in_transit</em>,
            <em>out_for_delivery</em>, <em>customs_clearance_delayed</em>, <em>attempted_delivery</em>,
            <em>ready_for_pickup</em>, <em>delivered_to_drop_point</em>, <em>delivered</em>,
            <em>returned</em>, <em>undeliverable</em> or <em>unknown</em>
          type: string
          readOnly: false
        time:
          description: Time the event occured at the carrier
          type: string
          readOnly: false
        description:
          description: Readable description of the event
          type: string
          readOnly: false
        location:
          description: ''
          type: string
          readOnly: false
        latitude:
          description: ''
          type: number
          readOnly: false
        longitude:
          description: ''
          type: number
          readOnly: false
        tracking_number:
          description: The tracking number for this event, if availiable
          type: string
          readOnly: false
        event_id:
          description: Unique event of the id
          type: string
          readOnly: false
        shipment_id:
          description: ID of shipment
          type: integer
          readOnly: false
        tracking_link_id:
          description: ''
          type: integer
          readOnly: false
        tracking_link_url:
          description: The tracking link for this event, if availiable
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    triggers:
      type: object
      properties:
        expression:
          description: WEL expression for the trigger
          type: string
          readOnly: false
        expression_ast:
          description: ''
          type: string
          readOnly: false
        model_type:
          description: Model for the trigger. E.g. Order
          type: string
          readOnly: false
        event:
          description: "<code>created</code> or <code>updated</code>"
          type: string
          readOnly: false
        timing:
          description: ''
          type: integer
          readOnly: false
    users:
      type: object
      properties:
        first_name:
          description: The user's first name.
          type: string
          readOnly: false
        last_name:
          description: The user's last name.
          type: string
          readOnly: false
        email:
          description: The user's e-mail address.
          type: string
          readOnly: false
        password:
          description: The user's password. This can only be used for changing the
            password.
          type: integer
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        last_sign_in_at:
          description: The time of the most recent sign-in by the user.
          type: string
          readOnly: false
        all_order_channels:
          description: Specifies whether the user has access to all order channels
            on the tenant.
          type: boolean
          readOnly: false
        all_carriers:
          description: Specifies whether the user has access to all of the carriers
            for tenant.
          type: boolean
          readOnly: false
        hidden:
          description: Specifies whether the user should be hidden in the user interface.
          type: boolean
          readOnly: false
        current_password:
          description: This must be set when changing the password of the user.
          type: string
          readOnly: false
        locale:
          description: Locale enum. <code>da</code> or <code>en</code>
          type: integer
          readOnly: false
        locked_until:
          description: Locked until specified datetime
          type: string
          readOnly: false
        failed_count:
          description: Amount of failed login attempts since last login
          type: integer
          readOnly: false
        is_locked:
          description: Read only. Will be true when the user is temporarily locked
            due to too many login attempts
          type: string
          readOnly: false
        user_status:
          description: ''
          type: integer
          readOnly: false
        home_page:
          description: The home page set by the user
          type: string
          readOnly: false
        limit_order_search:
          description: ''
          type: string
          readOnly: false
        view_ids:
          description: ''
          type: boolean
          readOnly: false
    user_groups:
      type: object
      properties:
        name:
          description: Name of the user group
          type: string
          readOnly: false
        scopes:
          description: Array of scopes. Please see section 6 for more details regarding
            scopes.
          type: array
          readOnly: false
          items:
            type: string
        locked:
          description: ''
          type: boolean
          readOnly: false
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
    waybills:
      type: object
      properties:
        waybill_name:
          description: Name of the waybill type
          type: string
          readOnly: false
        waybill_code:
          description: Code identifying the type of waybill
          type: string
          readOnly: false
        reference:
          description: Unique reference returned from the carrier implementation when
            a waybill is opened.
          type: string
          readOnly: false
        consolidation_key:
          description: ''
          type: string
          readOnly: false
        barcode_serial:
          description: This will be assigned by the API if the waybill type has a
            barcode requirement.
          type: integer
          readOnly: false
        status:
          description: Indicates whether the waybill is open or closed. When you want
            to close the waybill, you simply need to update the status of the way
            bill and set it to closed.
          type: integer
          readOnly: false
        shipment_count:
          description: This is a read-only attribute which returns the total number
            of shipments.
          type: string
          readOnly: false
        currency:
          description: ''
          type: string
          readOnly: false
        copies:
          description: ''
          type: integer
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        documents:
          description: Array of documents. This is available when the waybill is closed.
          type: string
          readOnly: false
    webhooks:
      type: object
      properties:
        url:
          description: The HTTP endpoint to be called. Webhooks always use POST as
            the request method.
          type: string
          readOnly: false
        topic:
          description: |-
            Which event should trigger the webhooks. Supported topics:
                <ul>
                  <li><strong>order/created</strong> triggered when an order is created.</li>
                  <li><strong>order/updated</strong> triggered when an order is updated.</li>
                  <li><strong>order/deleted</strong> triggered when an order was deleted.</li>
                  <li><strong>shipment/created</strong> triggered when a shipment is created.</li>
                  <li><strong>shipment/updated</strong> triggered when a shipment is updated.</li>
                  <li><strong>shipment/deleted</strong> triggered when a shipment was deleted.</li>
                  <li><strong>return/created</strong> triggered when a return is created.</li>
                  <li><strong>return/updated</strong> triggered when a return is updated.</li>
                  <li><strong>return/deleted</strong> triggered when a return was deleted.</li>
                  <li><strong>report/created</strong> triggered when a report is created.</li>
                  <li><strong>report/updated</strong> triggered when a report is updated.</li>
                  <li><strong>report/deleted</strong> triggered when a report was deleted.</li>
                  <li><strong>trackingevent/created</strong> triggered when a tracking event is created.</li>
                  <li><strong>trackingevent/updated</strong> triggered when a tracking event is updated.</li>
                  <li><strong>trackingevent/deleted</strong> triggered when a tracking event was deleted.</li>
                </ul>
          type: string
          readOnly: false
        enabled:
          description: This is a boolean attribute that specifies whether the webhook
            is active.
          type: boolean
          readOnly: false
        secret:
          description: The secret used to sign the HMAC.
          type: string
          readOnly: false
        health:
          description: ''
          type: string
          readOnly: false
        latest_error:
          description: The most recent error message.
          type: string
          readOnly: false
        condition:
          description: ''
          type: string
          readOnly: false
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
        carriers:
          description: ''
          type: string
          readOnly: false
        order_channels:
          description: 'Array of objects containing keys id and channel_label if condition
            describes a list of allowed order channels, <code>null</code> otherwise. '
          type: array
          readOnly: true
          items:
            type: string
    webhook_failures:
      type: object
      properties:
        record_id:
          description: The id of the record the webhook failed to send
          type: integer
          readOnly: true
        message:
          description: Title of the failure
          type: string
          readOnly: true
        created_at:
          description: The time when the resource was created
          type: string
          readOnly: true
        updated_at:
          description: The time when resource was last updated or when it was created
            if it was never updated
          type: string
          readOnly: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: ''
security:
- BearerAuth: []
tags:
- name: Action
  description: Actions as part of automations
- name: Activity
  description: Resource for activity.
- name: Activity Types
  description: Read only resource for activity types.
- name: Additional Attribute
  description: This resource is used to attach info to orders and order lines
- name: Attachment
  description: Attachment are used to associate existing Documents with Orders and
    Shipments.
- name: Automation
  description: With Automations you can build custom workflows on the Webshipper platform
    using highly flexible Triggers and Actions.
- name: Automations Dry Run
  description: " "
- name: Barcode Range
  description: This resource is used to describe the barcode ranges provided to you
    by a carrier.
- name: Bulk import orders
  description: Bulk import orders based on an array of ids
- name: CSV Mapping
  description: Describes how to parse an uploaded CSV file
- name: CSV Mapping Rule
  description: Describes how an entry in a CSV file should map to an attribute in
    a resource.
- name: CSV Upload
  description: Used to import records from CSV files (or similar formats). CSV Mapping
    Rules provides the details for how to import the records.
- name: Carrier
  description: ''
- name: Carrier Access
  description: Grants access to the carrier's shipments for a single user. This has
    no effect if the user has access to all carriers.
- name: Carrier Type
  description: Read-only endpoint to fetch information of the available carrier types.
- name: Comment
  description: Comments are used to add information to a model. The model can be a
    shipment, order or return .
- name: Customs Line
  description: Customs Lines is generally created as part of a shipment creation and
    should it should never be necessary to call this resource directly.
- name: Document
  description: Additional shipment documents. This is used for customs declarations
    etc. Documents are limited to 5mb.
- name: Document Templates
  description: Read only resource for document templates.
- name: Drop Point Locator
  description: Used to find the geographically closest drop points.
- name: EDI
  description: This resource describes an EDI file. This file will be uploaded to
    an FTP server configured by the carrier.
- name: End-of-day report
  description: A report of all shipment for the day of start_time.
- name: Error Type
  description: " "
- name: Event
  description: Timeline event for orders or shipments
- name: EventModel
  description: " "
- name: Favourite Page
  description: Favourite page lets you store a list of favourite pages to easily navigate
    the Webshipper platform. The favourites can quickly be accessed by assigning it
    a hotkey
- name: Has Documents
  description: " "
- name: HotKey
  description: Hot key lets you define a key combination for quickly accessing your
    favourite pages
- name: Label
  description: 'A shipping label. Shipping labels wrap PDF documents.<br>Accepts a
    query parameter called ''download_as'' which can be either ''PDF'' or ''PNG''.<br><b>Note</b>:
    when ''download_as'' is set to something other than PDF, the returned value in
    the base64 attribute will be an array of base64 strings, instead of a single base64
    string'
- name: Local Attribute
  description: As opposed to Global Attributes, Local Attributes are used for creating
    Attributes for Order Channels and Carriers.
- name: Local Attribute Enums
  description: A set of predefined values allowed for a Local Attribute.
- name: Mail Template Preview
  description: " "
- name: Mail Templates
  description: " "
- name: Merged Order
  description: " "
- name: Merged PDF
  description: " "
- name: Model
  description: " "
- name: OAuth Access Token
  description: This resource describes all of the access tokens for the appllication.
- name: OAuth Application
  description: Applications which can act on behalf of users in Webshipper. Application
    Tokens have infinite lifetime. See the section titled Authentication for more
    details on using OAuth2.
- name: Order
  description: Orders can be used to keep track of items to be shipped, for example
    when preparing the contents of a parcel and following that, an order can be the
    basis for one or more shipments. Orders can also handle customs information as
    well as shipping rates.
- name: Order Channel
  description: "An order channel models a specific integration with a webshop or ERP-system.
    Order channels are configured with attributes. During setup, 'additional_parameters'
    can be used to support customer authorisation flow (like the OAuth2 Authorisation
    Code grant type).\n    "
- name: Order Channel Access
  description: Grants a user access to an order channel. This has no effect if the
    user has been granted access to all order channels.
- name: Order Channel Type
  description: 'Order Channel Types are used to create Order Channels '
- name: Order Line
  description: " "
- name: Package
  description: " "
- name: Pickup
  description: Pickups facilitates the booking of a pickup from a given carrier. Not
    all carriers supports pickup.
- name: Print Bulk Slips
  description: Bulk add slips to the printer queue
- name: Printable
  description: " "
- name: Printer
  description: Printers are loaded automatically when connecting to your account from
    the Webshipper Silent Printer application.
- name: Printer Client
  description: Printer clients are created automatically when connecting Webshipper
    Silent Printer and should not be created manually.
- name: Printer Job
  description: Printer Jobs are used to print documents, labels etc. After a Printer
    Job is created, it will the sent to the printer client installed on one of your
    machines. After the printer client has accepted the job, it will mark the Printer
    Job as completed.
- name: Quote Object
  description: " "
- name: Rate Quote
  description: Get rates for an order channel. This provides a list of all shipping
    rates whose conditions matched the input. Quotes are not persistent. The id field
    is always returned as 1 and should be ignored.
- name: Report
  description: Reports are generated by using Report Types which specify how a report
    should look and which records to include in the report.
- name: Report Type
  description: This resource acts a template for creating resource.
- name: Requeueable Printer Jobs
  description: Find and requeue failed printer jobs within the given timeframe
- name: Return Causes
  description: Description of the cause
- name: Return Lines
  description: Read only resource for return lines.
- name: Return Order
  description: " "
- name: Return Portal
  description: " "
- name: Return Shipping Method
  description: " "
- name: Service Quote
  description: Service Quotes are used to find suitable services by quoting the carriers
    directly.
- name: Shipment
  description: |+
    When a shipment is created, a booking is made with the carrier.
        Once shipments have been created only packages can be modified. Existing packages can be updated and packages can be added or removed.
        Creating a shipment with only a single relationship to an order will populate the shipment with attributes from the order.
        This will result in a single package containing all of the order lines of the order. Creating multiple shipments from the same order will create shipments with empty packages with the default weight of 1000g.

    <br/><br/>
    <strong>Carrier, carrier service, service attributes and add-ons</strong> can either be assigned manually by filling in the respective relations and attributes or by using shipping rates.
     Shipping rates are pre-configurations of these relations and attribute, and thus you are able to omit all of these relations and attributes by using shipping rates.
    <br/><br/>
    <strong>All addresses, customs details etc. can be omitted</strong> by assigning an order relation to the shipment, and hence all of this information will be fetched directly from the order. Once the shipment has been sent, the order status will be automatically updated.
    <br/><br/>
    <strong>Updating a shipment</strong><br />
    Only the below fields are updateable. Shipment updates are intended for making smaller changes to a shipment before shipping time, i.e. adding or removing a package or pallet, changing number of exchange pallets, etc.
    If you need to make larger changes to a shipment you should instead delete the shipment and create a new one. Please note that deleting the shipment in Webshipper might not cancel the shipment with the carrier and as such might still incur charges from the carrier.

    <ul>
          <li>fulfill_immediately</li><li>packages</li><li>service_attributes</li><li>add_ons</li><li>included_documents</li><li>status</li><li>comment</li>
    </ul>

    Please note that when updating shipments you should only include fields that you wish to change, and if you only wish to change part of a field, i.e. add a package to an existing set of packages, you should include all current data.
    For adding a package that means you should include the array of packages as it is before the change, remember to include ids for each existing package. New packages should not have an id. If you leave out ids for an existing object it will be deleted and recreated, this might result in new barcodes and other changes.

    You can see an example of updating package data in the "use cases" tab to the right.

- name: Shipping Address
  description: " "
- name: Shipping Mapping
  description: A shipping mapping maps unknown shipping methods to one of the order
    channel's known shipping rates after an order is created. In the Webshipper user
    interface, this feature is known as linking shipping rates.
- name: Shipping Rate
  description: |-
    In most e-commerce systems, a shipping rate is displayed as a selectable option.<br>
    Shipping rates have many regions, and each of these regions has one or more expressions. Expressions are strings that are evaluated to see if the shipping rate matches the input, please see section <em>1.2 Common use Cases, Quoting an Order Channel for Shipping Rates.</em>
- name: Shipping Rate Expression
  description: Shipping rate expressions wraps expressions from the Webshipper Expression
    Language (WEL) with price details. When the WEL evaluates to true, the shipping
    rate will be returned in a rate quote. Please see section 8 for details regarding
    expressions.
- name: Shipping Region
  description: Shipping regions handle multiple countries as a group, e.g. the European
    Union.
- name: Slip Template
  description: Templates for generating parcel slips. The Webshipper Template Language
    (WTL) may be used when creating templates.
- name: Slip Template Preview
  description: " "
- name: Store
  description: Used for click n collect if activated on the shipping rate.
- name: Tag
  description: Read only resources describing all tags used. The index action returns
    a unique list of all tags currently
- name: Tracking Event
  description: ''
- name: Trigger
  description: Trigger for automations. When evaluated to true, the automation will
    start.
- name: User
  description: " "
- name: User Group
  description: " "
- name: Waybill
  description: " "
- name: Webhook
  description: "<p>Webhooks allow you to receive events from the Webshipper platform
    when resources are created, updated and changed.\n      Endpoints <b>must reply
    with a status code 200 for successful requests</b> within the timeout of 7 seconds.
    Any validation error on you side must not result in the error response.\n      Other
    statuses (including redirects) are treated as errors. </p>\n\n      <p> Webhook
    payloads are formatted as JSONAPI resources similar to other resources in the
    API.\n          Webhook payloads for tracking events have the related shipment
    and order sideloaded under 'included'.\n          Webhook payloads for shipments
    have the related order sideloaded under 'included'.</p>\n\n      <div class='card
    mb-2'><div class='card-body bg-warning text-white'>Webshipper highly recommends
    not processing webhooks immediately but instead putting the webhooks in a queue
    and then process the webhooks asynchronously.</div></div>\n\n      <p>\n      Webhooks
    are retried 21 times over a period of 8 days. An e-mail message will be sent to
    your account's technical contact if a webhook has been failing for 4 hours. After
    all retries have been exhaused, the webhook is disabled entirely and a new one
    must be created. The account's technical contact will also be notified by e-mail
    when a webhook is disabled in this scenario.</p><p>\n      All webhooks are sent
    using the X-Webshipper-Hmac-SHA256 header, which contains the Base64 encoding
    of the HMAC of the JSON request body signed with your customer secret using SHA256.
    Webhooks also include the X-Webshipper-Topic header used to indicate the webhook
    topic.\n      </p>\n\n      <p>\n      Example in Ruby: <pre><code class='ruby'>
    \ Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', secret, data)) </code>
    </pre>\n      Example in .NET <pre><code class='c-sharp'>\n  var request_body
    = \"RAW REQUEST BODY GOES HERE: IT IS UTF8 ENCODED ✅\";\n\n  var hmac = new HMACSHA256(
    Encoding.UTF8.GetBytes(\"secret123\"));\n  var digest = System.Convert.ToBase64String(hmac.ComputeHash(Encoding.UTF8.GetBytes(request_body)));\n
    \ Console.WriteLine(digest);\n          </code>\n        </pre>\n\n      </p>\n\n
    \     <p>Note that for 'deleted' webhooks, not all attributes can be expected
    to be present</p>\n      "
- name: Webhook Failure
  description: "<p>A log entry with details of a failed webhook request the last 7
    days.</p>"
