Whiplash Merchandising shipnotices API

openapi: 3.2.0
info:
  version: '2.0'
  title: Rydership bundle_items Shipnotices 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: shipnotices
  description: 'A Shipnotice is the opposite of an order, and are notifications by the client of inventory that is expected to arrive at a warehouse.

    Shipnotices represent incoming stock.'
paths:
  /api/v2/shipnotices:
    get:
      operationId: GetApiV2Shipnotices
      tags:
      - shipnotices
      summary: List all ship notices
      description: Get all shipnotices
      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: Get all shipnotices
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesShipnotice'
              examples:
                api.v2.shipnotice.all:
                  $ref: '#/components/examples/api.v2.shipnotice.all'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
    post:
      operationId: PostApiV2Shipnotices
      tags:
      - shipnotices
      summary: Create a ship notice
      description: Create a shipnotice
      parameters: []
      responses:
        '201':
          description: Create a shipnotice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesShipnotice'
              examples:
                api.v2.shipnotice.in_transit:
                  $ref: '#/components/examples/api.v2.shipnotice.in_transit'
        '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/PostApiV2ShipnoticesRequest'
  /api/v2/shipnotices/actions:
    get:
      operationId: GetApiV2ShipnoticesActions
      tags:
      - shipnotices
      summary: List actions you can perform
      description: Get resource actions
      parameters: []
      responses:
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
  /api/v2/shipnotices/bulk:
    post:
      operationId: PostApiV2ShipnoticesBulk
      tags:
      - shipnotices
      summary: Create shipnotices in bulk
      description: Create shipnotices in bulk
      parameters: []
      responses:
        '201':
          description: Create shipnotices in bulk
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesResult'
              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/PostApiV2ShipnoticesBulkRequest'
  /api/v2/shipnotices/count:
    get:
      operationId: GetApiV2ShipnoticesCount
      tags:
      - shipnotices
      summary: Count ship notices
      description: Returns count of shipnotices
      parameters:
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: 'JSON search string like {"attribute_eq": "Term"}'
      responses:
        '200':
          description: Returns count of shipnotices
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesCount'
              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/shipnotices/{id}:
    get:
      operationId: GetApiV2ShipnoticesId
      tags:
      - shipnotices
      summary: Retrieve a ship notice
      description: Get a Shipnotice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Get a Shipnotice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesShipnotice'
              examples:
                api.v2.shipnotice.processing:
                  $ref: '#/components/examples/api.v2.shipnotice.processing'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
    put:
      operationId: PutApiV2ShipnoticesId
      tags:
      - shipnotices
      summary: Update a ship notice
      description: Update a shipnotice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Update a shipnotice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesShipnotice'
              examples:
                api.v2.shipnotice.in_transit:
                  $ref: '#/components/examples/api.v2.shipnotice.in_transit'
        '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/PutApiV2ShipnoticesIdRequest'
    delete:
      operationId: DeleteApiV2ShipnoticesId
      tags:
      - shipnotices
      summary: Destroy a ship notice
      description: Destroy a shipnotice
      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'
  /api/v2/shipnotices/{id}/meta_fields:
    get:
      operationId: GetApiV2ShipnoticesIdMetaFields
      tags:
      - shipnotices
      summary: List meta fields
      description: Get the meta fields for a(n) Shipnotice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: associations
        in: query
        required: false
        schema:
          type: array
          description: Include meta fields for associations
          items:
            type: string
      responses:
        '200':
          description: Get the meta fields for a(n) Shipnotice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesMetaFields'
              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: PutApiV2ShipnoticesIdMetaFields
      tags:
      - shipnotices
      summary: Set meta fields
      description: Update Shipnotice meta fields
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Successfully updated
        '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/PutApiV2ShipnoticesIdMetaFieldsRequest'
  /api/v2/shipnotices/{id}/orders_waiting:
    get:
      operationId: GetApiV2ShipnoticesIdOrdersWaiting
      tags:
      - shipnotices
      summary: Count orders waiting for stock in a ship notice
      description: Get the count of orders waiting for the shipnotice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Get the count of orders waiting for the shipnotice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesCount'
              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/shipnotices/{id}/shipnotice_items:
    get:
      operationId: GetApiV2ShipnoticesIdShipnoticeItems
      tags:
      - shipnotices
      summary: List associated ship notice items
      description: List all shipnotice items for a(n) shipnotice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - 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: List all shipnotice items for a(n) shipnotice
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesShipnoticeItem'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
    post:
      operationId: PostApiV2ShipnoticesIdShipnoticeItems
      tags:
      - shipnotices
      summary: Create a ship notice item
      description: create a shipnotice item
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '201':
          description: create a shipnotice item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesShipnoticeItem'
              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/PostApiV2ShipnoticesIdShipnoticeItemsRequest'
  /api/v2/shipnotices/{id}/shipnotice_items/count:
    get:
      operationId: GetApiV2ShipnoticesIdShipnoticeItemsCount
      tags:
      - shipnotices
      summary: Count associated ship notice items
      description: Get a count of shipnotice items for a(n) shipnotice
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: 'JSON search string like {"attribute_eq": "Term"}'
      responses:
        '200':
          description: Get a count of shipnotice items for a(n) shipnotice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesCount'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
components:
  schemas:
    ApiV2EntitiesCustomer:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the customer id
        name:
          type: string
          description: Customer name.
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the customer creation date and time
        active:
          type:
          - boolean
          - 'null'
          description: Customer active?
        auto_merge_gestation:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer auto merge gestation.
        default_warehouse_id:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer default warehouse id.
        eori_number:
          type:
          - string
          - 'null'
          description: Customer EORI number.
        estimated_monthly_volume:
          type:
          - string
          - 'null'
          description: Customer estimated monthly volume.
        fedex_account:
          type:
          - string
          - 'null'
          description: Customer FedEx account.
        from_email:
          type:
          - string
          - 'null'
          description: Customer from email.
        incoterm:
          type: string
          description: Customer incoterm.
        instructions:
          type:
          - string
          - 'null'
          description: Customer instructions.
        item_scanning_preference:
          type:
          - boolean
          - 'null'
          description: Customer has item scanning preference?
        label_format:
          type:
          - string
          - 'null'
          description: Customer label format.
        notes:
          type:
          - string
          - 'null'
          description: Customer notes.
        notify_originator:
          type:
          - boolean
          - 'null'
          description: notify originator?
        notify_originator_inventory:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer notify originator inventory.
        originator_permissions:
          type:
          - boolean
          - 'null'
          description: originator permissions?
        packing_slip_msg:
          type:
          - string
          - 'null'
          description: Customer packing slip message.
        packingslip_template:
          type:
          - string
          - 'null'
          description: Customer packing slip template.
        request_serial_numbers:
          type:
          - boolean
          - 'null'
          description: request serial numbers?
        ship_method_preference:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer shipping method preference.
        shipping_name:
          type:
          - string
          - 'null'
          description: Customer shipping name.
        ups_account:
          type:
          - string
          - 'null'
          description: Customer UPS account.
        vat_number:
          type:
          - string
          - 'null'
          description: Customer VAT number.
        ein:
          type:
          - string
          - 'null'
          description: Customer EIN / Tax ID
        gs1_company_prefix:
          type:
          - string
          - 'null'
          description: GS1 company prefix for barcodes
        warehouse_fallback:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer warehouse fallback.
        payment_hold:
          type: boolean
          description: is this account on hold pending a valid payment method?
        primary_contact:
          type: string
          description: The Customers designated primary contact.
        global_e_guid:
          type:
          - string
          - 'null'
          description: Customer Global-E GUID.
        exit_notice:
          type:
          - boolean
          - 'null'
          description: is this account flagged for exit notice? (admins only)
        data_mapping_string:
          type:
          - string
          - 'null'
          description: Data mapping string for this customer. (admins only)
        whitelisted_warehouses:
          $ref: '#/components/schemas/ApiV2EntitiesWarehouse'
        allowed_warehouse_ids:
          type: array
          items:
            type: integer
            format: int32
        account_level:
          type: integer
          format: int32
          description: Account level
        account_level_name:
          type: string
          description: Quote, Direct, Enterprise, or Managed
        activated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the customer activation date and time
        deactivated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: the customer deactivation date and time
        auto_merge_skus:
          type:
          - boolean
          - 'null'
          description: auto merge SKUs?
        partner_id:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer partner id. (admins only)
        billing_email:
          type:
          - string
          - 'null'
          description: Customer billing email.
        billing_contact_name:
          type:
          - string
          - 'null'
          description: Customer billing contact name.
        billing_company:
          type:
          - string
          - 'null'
          description: Customer billing company.
        billing_phone1:
          type:
          - string
          - 'null'
          description: Customer phone 1.
        billing_phone2:
          type:
          - string
          - 'null'
          description: Customer phone 2.
        billing_address1:
          type:
          - string
          - 'null'
          description: Customer billing address line 1.
        billing_address2:
          type:
          - string
          - 'null'
          description: Customer billing address line 2.
        billing_address3:
          type:
          - string
          - 'null'
          description: Customer billing address line 3.
        billing_city:
          type:
          - string
          - 'null'
          description: Customer billing city.
        billing_state:
          type:
          - string
          - 'null'
          description: Customer billing state.
        billing_zip:
          type:
          - string
          - 'null'
          description: Customer billing zip.
        billing_country:
          type:
          - string
          - 'null'
          description: Customer billing country.
        billing_residential:
          type:
          - boolean
          - 'null'
          description: Customer billing residential?
        items_returnable:
          type:
          - boolean
          - 'null'
          description: items returnable by default?
        allow_international_returns:
          type: boolean
          description: Allow International returns?
        items_exchangeable:
          type:
          - boolean
          - 'null'
          description: items exchangeable by default?
        return_time_limit:
          type:
          - integer
          - 'null'
          format: int32
          description: Return time limit.
        return_label_expires_in:
          type:
          - integer
          - 'null'
          format: int32
          description: Return label expiration time limit.
        return_price_restricted:
          type:
          - boolean
          - 'null'
          description: limit exchange to same value or less?
        return_sku_match:
          type:
          - string
          - 'null'
          description: Exchange SKU match policy.
        rma_display_logo:
          type:
          - boolean
          - 'null'
          description: display customer logo on returns page?
        rma_footer_content:
          type:
          - string
          - 'null'
          description: Return page footer content.
        return_name:
          type:
          - string
          - 'null'
          description: Customer return name.
        return_company:
          type:
          - string
          - 'null'
          description: Customer return company.
        return_email:
          type:
          - string
          - 'null'
          description: Customer return email.
        return_phone:
          type:
          - string
          - 'null'
          description: Customer return phone.
        return_address_1:
          type:
          - string
          - 'null'
          description: Customer return address line 1.
        return_address_2:
          type:
          - string
          - 'null'
          description: Customer return address line 2.
        return_city:
          type:
          - string
          - 'null'
          description: Customer return city.
        return_state:
          type:
          - string
          - 'null'
          description: Customer return state.
        return_zip:
          type:
          - string
          - 'null'
          description: Customer return zip.
        return_country:
          type:
          - string
          - 'null'
          description: Customer return country.
        supports_return_labels:
          type:
          - boolean
          - 'null'
          description: does the customer support return labels?
        logo_content_type:
          type:
          - string
          - 'null'
          description: Customer logo content type.
        logo_file_name:
          type:
          - string
          - 'null'
          description: Customer logo file name.
        logo_file_size:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer logo file size.
        logo_updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Customer logo updated at.
        full_logo_url:
          type: string
          description: Customer full logo url.
        email_confirmation_from:
          type:
          - string
          - 'null'
          description: Customer email confirmation from.
        email_confirmation_name:
          type:
          - string
          - 'null'
          description: Customer email confirmation name.
        email_confirmation_msg:
          type:
          - string
          - 'null'
          description: Customer email confirmation message.
        email_confirmation_preference:
          type:
          - integer
          - 'null'
          format: int32
          description: Customer email confirmation preference.
        email_confirmation_template:
          type:
          - string
          - 'null'
          description: Customer email confirmation template.
        low_inventory_threshold:
          type:
          - integer
          - 'null'
          format: int32
          description: Quantity where an item in inventory would be considered having low inventory
        lot_control:
          type:
          - boolean
          - 'null'
          description: do items for this customer require lot control?
        expiration_period:
          type:
          - integer
          - 'null'
          format: int32
          description: items that are this many days from expiration will not be allowed to ship
        ship_strategy:
          type:
          - integer
          - 'null'
          format: int32
          description: 'which locations to pick first: Default, FIFO, FEFO'
        items_unavailable_on_sellout:
          type:
          - integer
          - 'null'
          format: int32
          description: 'Process Orders setting: Whiplash will automatically turn on Process Orders when an item is received, and turn it off when an item sells. Whiplash will not manage Process Orders. Whiplash will automatically turn on Process Orders only the first time an Item is received. Whiplash will automatically turn on Process Orders when an item is received or adjusted in, and turn it off when an Item sells out.'
        replenishment_min:
          type:
          - string
          - 'null'
          description: Minimum number of days worth of stock to keep in forward pick locations
        replenishment_target:
          type:
          - string
          - 'null'
          description: Target number of days stock to replenish forward pick locations
        allow_b_stock_receiving:
          type:
          - boolean
          - 'null'
          description: Allow "b stock" role for receiving
        location_default_return_role:
          type: string
          description: Default role (i.e. Pickable, Damaged) for returned items
        location_enable_pending_returns:
          type: b

# --- truncated at 32 KB (164 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/whiplash-merchandising/refs/heads/main/openapi/whiplash-merchandising-shipnotices-api-openapi.yml