Whiplash Merchandising scancodes API

openapi: 3.1.0
info:
  version: '2.0'
  title: Rydership bundle_items scancodes API
  description: 'The Rydership V2 API is open by invite only. Fill out request form <a href="https://help.whiplash.com/hc/en-us/requests/new?ticket_form_id=360001303092"> here</a>.

    <br>

    <a href="api.v2.html">V2 documentation</a>

    <br>

    <a href="api.v2-1.html">V2.1 documentation</a>

    '
  contact:
    name: Rydership Development Team
    email: tech@whiplash.com
    url: https://www.getwhiplash.com
  x-logo:
    url: https://wl-s3-assets.s3.amazonaws.com/rydership/RyderShip-horizontal-safe-padding.svg
    backgroundColor: '#FFFFFF'
    altText: RyderShip
servers:
- url: ''
  description: Base Path
tags:
- name: scancodes
  description: Barcode management and processing.
paths:
  /api/v2/scancodes:
    post:
      operationId: PostApiV2Scancodes
      tags:
      - scancodes
      summary: Create a scancode
      description: Create a scancode
      parameters: []
      responses:
        '201':
          description: Create a scancode
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesScancode'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '409':
          description: conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV2ScancodesRequest'
components:
  schemas:
    PostApiV2ScancodesRequest:
      type: object
      properties:
        item_id:
          type: integer
          format: int32
          description: the item_id
        name:
          type: string
          description: the name for the scancode
      required:
      - item_id
      - name
    ApiV2EntitiesScancode:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the scancode id
        item_id:
          type:
          - integer
          - 'null'
          format: int32
          description: the item_id
        primary:
          type:
          - boolean
          - 'null'
          description: is this the primary scancode?
        customer_id:
          type:
          - integer
          - 'null'
          format: int32
          description: the customer_id
        name:
          type:
          - string
          - 'null'
          description: the name for the scancode
        scancode:
          type: string
          description: the name for the scancode (legacy)
        active:
          type:
          - boolean
          - 'null'
          description: is this scancode active?
        created_at:
          type: string
          format: date-time
          description: scancode creation date
        updated_at:
          type: string
          format: date-time
          description: scancode last updated date
        label_format:
          type:
          - string
          - 'null'
          description: label format for the scancode
      additionalProperties: false
    ApiSharedEntitiesApiError:
      type: object
      title: Shared
      properties:
        message:
          type: string
          description: error message
      additionalProperties: false