Whiplash Merchandising orders API
Orders are end consumer requests for Items. An Order is comprised of OrderItems. Orders represent outgoing stock.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/whiplash-merchandising-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.1.0
info:
version: '2.0'
title: Rydership bundle_items orders 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: orders
description: 'Orders are end consumer requests for Items. An Order is comprised of OrderItems.
Orders represent outgoing stock.'
paths:
/api/v2/orders:
get:
operationId: GetApiV2Orders
tags:
- orders
summary: List all orders
description: Retrieves a list of orders
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: Retrieves a list of orders
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesOrder'
examples:
api.v2.order.all:
$ref: '#/components/examples/api.v2.order.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: PostApiV2Orders
tags:
- orders
summary: Create an order
description: Create an order
parameters: []
responses:
'201':
description: Create an order
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOrder'
examples:
api.v2.order.processing:
$ref: '#/components/examples/api.v2.order.processing'
'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/PostApiV2OrdersRequest'
/api/v2/orders/actions:
get:
operationId: GetApiV2OrdersActions
tags:
- orders
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/orders/bulk:
post:
operationId: PostApiV2OrdersBulk
tags:
- orders
summary: Create orders in bulk
description: Create orders in bulk
parameters: []
responses:
'201':
description: Create orders 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/PostApiV2OrdersBulkRequest'
/api/v2/orders/count:
get:
operationId: GetApiV2OrdersCount
tags:
- orders
summary: Count orders
description: Returns count of orders
parameters:
- name: search
in: query
required: false
schema:
type: string
description: 'JSON search string like {"attribute_eq": "Term"}'
responses:
'200':
description: Returns count of orders
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/orders/{id}:
get:
operationId: GetApiV2OrdersId
tags:
- orders
summary: Retrieve an order
description: Retrieve an order
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Retrieve an order
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOrder'
examples:
api.v2.order.processing:
$ref: '#/components/examples/api.v2.order.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: PutApiV2OrdersId
tags:
- orders
summary: Update an order
description: Update an order
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Update an order
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOrder'
examples:
api.v2.order.processing:
$ref: '#/components/examples/api.v2.order.processing'
'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/PutApiV2OrdersIdRequest'
/api/v2/orders/{id}/call/{action}:
put:
operationId: PutApiV2OrdersIdCallAction
tags:
- orders
summary: Perform an action on an order
description: Perform an action on an order
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 order
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOrder'
examples:
api.v2.order.processing:
$ref: '#/components/examples/api.v2.order.processing'
'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/PutApiV2OrdersIdCallActionRequest'
/api/v2/orders/{id}/customs_info:
get:
operationId: GetApiV2OrdersIdCustomsInfo
tags:
- orders
summary: Retrieve the CustomsInfo object for an order
description: get the CustomsInfo object for an order
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: get the CustomsInfo object for an order
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesCustomsInfo'
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/orders/{id}/events:
get:
operationId: GetApiV2OrdersIdEvents
tags:
- orders
summary: Retrieve the history for an order
description: Get the order history
parameters:
- name: id
in: path
required: true
schema:
type: integer
- 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 order history
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesOrderEvent'
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/orders/{id}/events/count:
get:
operationId: GetApiV2OrdersIdEventsCount
tags:
- orders
summary: Count order's events
description: Returns count of order's events
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 order's events
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/orders/{id}/meta_fields:
get:
operationId: GetApiV2OrdersIdMetaFields
tags:
- orders
summary: List meta fields
description: Get the meta fields for a(n) Order
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) Order
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: PutApiV2OrdersIdMetaFields
tags:
- orders
summary: Set meta fields
description: Update Order 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/PutApiV2OrdersIdMetaFieldsRequest'
/api/v2/orders/{id}/order_documents:
get:
operationId: GetApiV2OrdersIdOrderDocuments
tags:
- orders
summary: List all order documents for an order
description: Retrieve all order documents for an order
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: Retrieve all order documents for an order
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesOrderDocument'
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: PostApiV2OrdersIdOrderDocuments
tags:
- orders
summary: Create an order document for an order
description: Create an order document for an order
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'201':
description: Create an order document for an order
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOrderDocument'
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/PostApiV2OrdersIdOrderDocumentsRequest'
/api/v2/orders/{id}/order_documents/count:
get:
operationId: GetApiV2OrdersIdOrderDocumentsCount
tags:
- orders
summary: Count all order documents for an order
description: Retrieve count of all order documents for an order
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: Retrieve count of all order documents for an order
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/orders/{id}/order_items:
get:
operationId: GetApiV2OrdersIdOrderItems
tags:
- orders
summary: List all order items for an order
description: Retrieve all order items for an order
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: fields
in: query
required: false
schema:
type: string
description: Comma-separated list of fields to include in the response
- 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: Retrieve all order items for an order
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesOrderItem'
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: PostApiV2OrdersIdOrderItems
tags:
- orders
summary: Create an order item
description: Create an order item
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'201':
description: Create an order item
content:
application/json:
schema:
$ref: '#/components/schemas/ApiV2EntitiesOrderItem'
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/PostApiV2OrdersIdOrderItemsRequest'
/api/v2/orders/{id}/order_items/count:
get:
operationId: GetApiV2OrdersIdOrderItemsCount
tags:
- orders
summary: Count order items
description: Returns count of order items
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 order 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/orders/{id}/serial_numbers:
get:
operationId: GetApiV2OrdersIdSerialNumbers
tags:
- orders
summary: List all serial numbers associated with an order item
description: Get the serial numbers for an order
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Get the serial numbers for an order
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesSerialNumber'
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/orders/{id}/shipping_documents:
get:
operationId: GetApiV2OrdersIdShippingDocuments
tags:
- orders
summary: List shipping documents for a order
description: List all shipping documents for a order
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 shipping documents for a order
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiV2EntitiesShippingDocument'
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/orders/{id}/suggested_items:
get:
operationId: GetApiV2OrdersIdSuggestedItems
tags:
- orders
summary: Retrieve suggested items for an order
description: Get suggested items for an order
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: Get suggested items for an order
content:
application/json:
# --- truncated at 32 KB (228 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/whiplash-merchandising/refs/heads/main/openapi/whiplash-merchandising-orders-api-openapi.yml