openapi: 3.2.0
info:
  title: Online Store Order Shipments API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Order Shipments
paths:
  /order_shipments:
    get:
      summary: Get Order Shipments
      tags:
      - Order Shipments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  order_shipments:
                    type: array
                    items:
                      $ref: '#/components/schemas/order_shipments'
      operationId: get-order_shipments
      description: Gets an array of order shipments.
    post:
      summary: Create an Order Shipment
      operationId: post-order_shipments
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_shipments'
      tags:
      - Order Shipments
      description: 'Creates an order shipment.

        '
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  order_id: 100297
                  shipped_at: '2021-09-06T00:00:00-05:00'
                  tracking_numbers: '123498776'
                  tracking_url: ''
                  shipping_method: UPS Ground
                  shipping_method_id: 1
                  number_of_packages: null
                  total_weight: null
                  provider_base_shipping_cost: ''
                  provider_insurance_cost: null
                  provider_handling_cost: null
                  provider_other_charges: null
                  provider_total_shipping_cost: null
                  email_sent: false
                  private_comment: ''
                  shipping_comment: ''
                  shipping_method_type: provider
                  shipment_name: '1'
                  shipping_provider_name: UPS
              properties:
                order_id:
                  type: integer
                shipped_at:
                  type: string
                tracking_numbers:
                  type: string
                tracking_url:
                  type: string
                shipping_method:
                  type: string
                shipping_method_id:
                  type: number
                  description: 'The id of the desired shipping method. This can be found by making a GET request to shipping_methods. This will be filled automatically if a valid shippping_method is provided. '
                number_of_packages:
                  type: integer
                total_weight:
                  type: number
                provider_base_shipping_cost:
                  type: string
                provider_insurance_cost:
                  type: number
                provider_handling_cost:
                  type: number
                provider_other_charges:
                  type: number
                provider_total_shipping_cost:
                  type: number
                email_sent:
                  type: boolean
                private_comment:
                  type: string
                shipping_comment:
                  type: string
                shipping_method_type:
                  type: string
                shipment_name:
                  type: string
                shipping_provider_name:
                  type: string
                items:
                  type: array
                  uniqueItems: false
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                      quantity_shipped:
                        type: integer
                      item_nr:
                        type: string
            examples:
              Example:
                value:
                  order_id: 100297
                  shipped_at: '2021-09-06T00:00:00-05:00'
                  tracking_numbers: '123498776'
                  tracking_url: ''
                  shipping_method: UPS Ground
                  shipping_method_id: 1
                  number_of_packages: 1
                  total_weight: 2
                  provider_base_shipping_cost: ''
                  provider_insurance_cost: 0
                  provider_handling_cost: 0
                  provider_other_charges: 0
                  provider_total_shipping_cost: 0
                  email_sent: false
                  private_comment: ''
                  shipping_comment: ''
                  shipping_method_type: provider
                  shipment_name: '1'
                  shipping_provider_name: UPS
                  items:
                  - id: 206
                    quantity_shipped: 1
                    item_ne: test1
  /order_shipments/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `order_shipment`
    put:
      summary: Update an Order Shipment
      operationId: put-order_shipments-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/order_shipments'
      tags:
      - Order Shipments
      description: Updates an order shipment.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/order_shipments'
    delete:
      summary: Delete an Order Shipment
      operationId: delete-order_shipments-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Order Shipments
      description: Deletes an order shipment.
components:
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  schemas:
    order_shipments:
      type: object
      properties:
        id:
          type: integer
        order_id:
          type: integer
        shipped_at:
          type: string
        tracking_numbers:
          type: string
        tracking_url:
          type: string
        shipping_method:
          type: string
        shipping_method_id:
          type: integer
        number_of_packages:
          type: integer
        total_weight:
          type: number
        provider_base_shipping_cost:
          type: string
        provider_insurance_cost:
          type: number
        provider_handling_cost:
          type: number
        provider_other_charges:
          type: number
        provider_total_shipping_cost:
          type: number
        email_sent:
          type: boolean
        private_comment:
          type: string
        shipping_comment:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        shipping_method_type:
          type: string
        shipment_name:
          type: string
        shipping_provider_name:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header