Whiplash Merchandising wholesale_items API

openapi: 3.1.0
info:
  version: '2.0'
  title: Rydership bundle_items wholesale_items 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: wholesale_items
paths:
  /api/v2/wholesale_items:
    get:
      operationId: GetApiV2WholesaleItems
      tags:
      - wholesale_items
      summary: List all wholesale item objects
      description: Returns all wholesale item objects
      parameters:
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: 'JSON search string like {"attribute_eq": "Term"}'
      - name: fields
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated list of fields to include in the response
      - name: sort
        in: query
        required: false
        schema:
          type: string
          description: 'A list of sort options (ex: name asc,created_at desc)'
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Page of results to fetch
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Number of results to return per page
      - name: page_total
        in: query
        required: false
        schema:
          type: boolean
          description: Include total count of results
      - name: page_links
        in: query
        required: false
        schema:
          type: boolean
          description: Include prev/next links in response headers
      responses:
        '200':
          description: Returns all wholesale item objects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesWholesaleItem'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
  /api/v2/wholesale_items/{id}:
    get:
      operationId: GetApiV2WholesaleItemsId
      tags:
      - wholesale_items
      summary: Retrieve a Wholesale item object
      description: get a Wholesale item object
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: get a Wholesale item object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesWholesaleItem'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
    put:
      operationId: PutApiV2WholesaleItemsId
      tags:
      - wholesale_items
      summary: Update a wholesale item object
      description: Update a wholesale item object
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Update a wholesale item object
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesWholesaleItem'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          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/PutApiV2WholesaleItemsIdRequest'
    delete:
      operationId: DeleteApiV2WholesaleItemsId
      tags:
      - wholesale_items
      summary: Delete a wholesale item object
      description: Delete a wholesale item object
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Successfully deleted
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '422':
          description: unprocessable_entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
components:
  schemas:
    PutApiV2WholesaleItemsIdRequest:
      type: object
      properties:
        order_item_id:
          type: integer
          format: int32
          description: the associated order item id
        line_no:
          type: string
          description: the line number
        item_alias:
          type: string
          description: the item alias
        item_color:
          type: string
          description: the item color
        item_size:
          type: string
          description: the item size
        vendor_part_number:
          type: string
          description: the vendor part number
        buyer_part_number:
          type: string
          description: the buyer part number
        consumer_package_code:
          type: string
          description: the consumer package code
        outer_pack_value:
          type: string
          description: the outer pack value
        inner_pack_value:
          type: string
          description: the inner pack value
        size_description:
          type: string
          description: the size description
        color_description:
          type: string
          description: the color description
        upc:
          type: string
          description: the UPC
        description:
          type: string
          description: the description
        style:
          type: string
          description: the style
        ean:
          type: string
          description: the EAN
        alternate_item_number:
          type: string
          description: the alternate item number
        alternate_barcode:
          type: string
          description: the alternate barcode
        alternate_sku:
          type: string
          description: the alternate SKU
        lot:
          type: string
          description: the lot
        ih_category:
          type: string
          description: the IH category
    ApiSharedEntitiesApiError:
      type: object
      title: Shared
      properties:
        message:
          type: string
          description: error message
      additionalProperties: false
    ApiV2EntitiesWholesaleItem:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the wholesale item id
        order_item_id:
          type: integer
          format: int32
          description: the associated order item id
        line_no:
          type:
          - string
          - 'null'
          description: the line number
        item_alias:
          type:
          - string
          - 'null'
          description: the item alias
        item_color:
          type:
          - string
          - 'null'
          description: the item color
        item_size:
          type:
          - string
          - 'null'
          description: the item size
        vendor_part_number:
          type:
          - string
          - 'null'
          description: the vendor part number
        buyer_part_number:
          type:
          - string
          - 'null'
          description: the buyer part number
        consumer_package_code:
          type:
          - string
          - 'null'
          description: the consumer package code
        outer_pack_value:
          type:
          - string
          - 'null'
          description: the outer pack value
        inner_pack_value:
          type:
          - string
          - 'null'
          description: the inner pack value
        size_description:
          type:
          - string
          - 'null'
          description: the size description
        color_description:
          type:
          - string
          - 'null'
          description: the color description
        upc:
          type:
          - string
          - 'null'
          description: the UPC
        description:
          type:
          - string
          - 'null'
          description: the description
        style:
          type:
          - string
          - 'null'
          description: the style
        ean:
          type:
          - string
          - 'null'
          description: the EAN
        alternate_item_number:
          type:
          - string
          - 'null'
          description: the alternate item number
        alternate_barcode:
          type:
          - string
          - 'null'
          description: the alternate barcode
        alternate_sku:
          type:
          - string
          - 'null'
          description: the alternate SKU
        lot:
          type:
          - string
          - 'null'
          description: the lot
        ih_category:
          type:
          - string
          - 'null'
          description: the IH category
        created_at:
          type: string
          format: date-time
          description: the wholesale item creation date and time
        updated_at:
          type: string
          format: date-time
          description: the wholesale item last update date and time
      additionalProperties: false