Items are probably the most fundamental entity in the Whiplash system. An item is simply a 'shippable unit'. So, it's not a Whiplash T-Shirt; it's a Small Whiplash T-Shirt, for instance. Most commerce platforms model Products. Typically, however, a Product (e.g. a T-Shirt) has variations (named variously, Variants, ProductOptions, OptionSets, etc). An Item maps to the Variant/Option, not the Product.
openapi: 3.1.0
info:
version: '2.0'
title: Rydership bundle_items 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: items
description: 'Items are probably the most fundamental entity in the Whiplash system. An item is simply a ''shippable unit''. So, it''s not a Whiplash T-Shirt; it''s a Small Whiplash T-Shirt, for instance.
Most commerce platforms model Products. Typically, however, a Product (e.g. a T-Shirt) has variations (named variously, Variants, ProductOptions, OptionSets, etc). An Item maps to the Variant/Option, not the Product.'
paths:
/api/v2/items:
get:
operationId: GetApiV2Items
tags:
- items
summary: List all items
description: 'Get a list of items '
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 a list of items '
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesItem'
examples:
api.v2.item.merch:
$ref: '#/components/examples/api.v2.item.merch'
api.v2.item.packaging:
$ref: '#/components/examples/api.v2.item.packaging'
api.v2.item.bundle:
$ref: '#/components/examples/api.v2.item.bundle'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
post:
operationId: PostApiV2Items
tags:
- items
summary: Create an item
description: Create an item
parameters: []
responses:
'201':
description: Create an item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesItem'
examples:
api.v2.item.single:
$ref: '#/components/examples/api.v2.item.single'
'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/PostApiV2ItemsRequest'
/api/v2/items/actions:
get:
operationId: GetApiV2ItemsActions
tags:
- items
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/items/count:
get:
operationId: GetApiV2ItemsCount
tags:
- items
summary: Count items
description: Returns count of items
parameters:
- name: search
in: query
required: false
schema:
type: string
description: 'JSON search string like {"attribute_eq": "Term"}'
responses:
'200':
description: Returns count of items
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/items/{id}:
get:
operationId: GetApiV2ItemsId
tags:
- items
summary: Retrieve an item
description: Get an item
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Get an item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesItem'
examples:
api.v2.item.single:
$ref: '#/components/examples/api.v2.item.single'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
put:
operationId: PutApiV2ItemsId
tags:
- items
summary: Update an item
description: Update an item
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Update an item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesItem'
examples:
api.v2.item.single:
$ref: '#/components/examples/api.v2.item.single'
'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/PutApiV2ItemsIdRequest'
delete:
operationId: DeleteApiV2ItemsId
tags:
- items
summary: Archive an item
description: Destroy an item
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/items/{id}/bundle_items:
get:
operationId: GetApiV2ItemsIdBundleItems
tags:
- items
summary: List all bundle items containing this item
description: Shows all bundle items containing this item
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Shows all bundle items containing this item
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesBundleItem'
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: PostApiV2ItemsIdBundleItems
tags:
- items
summary: Add an item to an bundle
description: Add an item to an bundle
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'201':
description: Add an item to an bundle
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesBundleItem'
examples: null
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostApiV2ItemsIdBundleItemsRequest'
/api/v2/items/{id}/call/{action}:
put:
operationId: PutApiV2ItemsIdCallAction
tags:
- items
summary: Perform an action on an item
description: Perform an action on an item
parameters:
- name: action
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Perform an action on an item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesItem'
examples:
api.v2.item.single:
$ref: '#/components/examples/api.v2.item.single'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'405':
description: method_not_allowed
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/PutApiV2ItemsIdCallActionRequest'
/api/v2/items/{id}/in_bundles:
get:
operationId: GetApiV2ItemsIdInBundles
tags:
- items
summary: List all instances of this item in bundles
description: Shows all instances of this item in bundles
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Shows all instances of this item in bundles
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesItem'
examples:
api.v2.item.single:
$ref: '#/components/examples/api.v2.item.single'
'401':
description: unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
'403':
description: forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiSharedEntitiesApiError'
/api/v2/items/{id}/locations_with_transfer_count:
get:
operationId: GetApiV2ItemsIdLocationsWithTransferCount
tags:
- items
summary: List locations associated with this item - by role
description: show locations associated with this item
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: role
in: query
required: false
schema:
type: string
enum:
- pickable
- backstock
- damaged
- expired
- reserved
- pending
- external
- dropoff
- b_stock
description: Pickable, backstock, etc
- name: page
in: query
required: false
schema:
type: integer
format: int32
description: Page number for pagination
- name: per_page
in: query
required: false
schema:
type: integer
format: int32
description: Number of locations per page for pagination
- name: name
in: query
required: false
schema:
type: string
description: the location name
responses:
'200':
description: show locations associated with this item
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesItemLocation'
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/items/{id}/meta_fields:
get:
operationId: GetApiV2ItemsIdMetaFields
tags:
- items
summary: List meta fields
description: Get the meta fields for a(n) Item
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) Item
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: PutApiV2ItemsIdMetaFields
tags:
- items
summary: Set meta fields
description: Update Item 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/PutApiV2ItemsIdMetaFieldsRequest'
/api/v2/items/{id}/originators:
get:
operationId: GetApiV2ItemsIdOriginators
tags:
- items
summary: List associated originators
description: Get the originators for a(n) Item
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: 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 the originators for a(n) Item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOriginator'
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/items/{id}/originators/count:
get:
operationId: GetApiV2ItemsIdOriginatorsCount
tags:
- items
summary: Count originators
description: Get the count of originators for a(n) Item
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 the count of originators for a(n) Item
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/items/{id}/scancodes:
get:
operationId: GetApiV2ItemsIdScancodes
tags:
- items
summary: List all scancodes associated with this item
description: show scancodes associated with this item
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: 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: show scancodes associated with this item
content:
application/json:
schema:
type: array
items:
$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'
/api/v2/items/{id}/shipnotice_items:
get:
operationId: GetApiV2ItemsIdShipnoticeItems
tags:
- items
summary: List associated ship notice items
description: List all shipnotice items for a(n) item
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) item
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'
/api/v2/items/{id}/shipnotice_items/count:
get:
operationId: GetApiV2ItemsIdShipnoticeItemsCount
tags:
- items
summary: Count associated ship notice items
description: Get a count of shipnotice items for a(n) item
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) item
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/items/{id}/transactions:
get:
operationId: GetApiV2ItemsIdTransactions
tags:
- items
summary: List an item's history
description: Get all transactions for an item
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: 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 transactions for an item
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesTransaction'
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/items/{id}/transactions/count:
get:
operationId: GetApiV2ItemsIdTransactionsCount
tags:
- items
summary: Count the transactions in an item's history
description: Returns count of item transactions
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: Returns count of item transactions
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/items/{id}/transactions/export:
get:
operationId: GetApiV2ItemsIdTransactionsExport
tags:
- items
summary: Export an item's transaction history
description: Export item transaction history to CSV
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Export item transaction history to CSV
content:
application/json:
schema:
$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'
/api/v2/items/{id}/warehouse_quantities:
get:
operationId: GetApiV2ItemsIdWarehouseQuantities
tags:
- items
summary: Item stock by warehouse
description: Shows the number of this item in the warehouse
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Shows the number of this item in the warehouse
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesItemWarehouseQuantity'
examples: null
'401':
description: unauthorized
content:
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/whiplash-merchandising/refs/heads/main/openapi/whiplash-merchandising-items-api-openapi.yml