Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Whiplash Merchandising orders API

Orders are end consumer requests for Items. An Order is comprised of OrderItems.Orders represent outgoing stock.

Whiplash Merchandising orders API is one of 21 APIs that Whiplash Merchandising publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 23 operations across 18 paths, and defines 25 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against the base URL https://www.getwhiplash.com/api/v2.

23 operations 18 paths 25 schemas 16 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://www.getwhiplash.com/api/v2
Resource Areas
1

Paths & Operations 23

Across 18 paths, the API surfaces 23 operations — 16 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

orders 23

Orders are end consumer requests for Items. An Order is comprised of OrderItems. Orders represent outgoing stock.

GET
/api/v2/orders
List all orders
GetApiV2Orders 7 params → 200401403
POST
/api/v2/orders
Create an order
PostApiV2Orders body → 201401403409422
GET
/api/v2/orders/actions
List actions you can perform
GetApiV2OrdersActions → 401403
POST
/api/v2/orders/bulk
Create orders in bulk
PostApiV2OrdersBulk body → 201401403409422
GET
/api/v2/orders/count
Count orders
GetApiV2OrdersCount 1 param → 200401403
GET
/api/v2/orders/{id}
Retrieve an order
GetApiV2OrdersId 1 param → 200401403
PUT
/api/v2/orders/{id}
Update an order
PutApiV2OrdersId 1 param body → 200401403422
PUT
/api/v2/orders/{id}/call/{action}
Perform an action on an order
PutApiV2OrdersIdCallAction 2 params body → 200401403405422
GET
/api/v2/orders/{id}/customs_info
Retrieve the CustomsInfo object for an order
GetApiV2OrdersIdCustomsInfo 1 param → 200401403
GET
/api/v2/orders/{id}/events
Retrieve the history for an order
GetApiV2OrdersIdEvents 5 params → 200401403
GET
/api/v2/orders/{id}/events/count
Count order's events
GetApiV2OrdersIdEventsCount 2 params → 200401403
GET
/api/v2/orders/{id}/meta_fields
List meta fields
GetApiV2OrdersIdMetaFields 2 params → 200401403
PUT
/api/v2/orders/{id}/meta_fields
Set meta fields
PutApiV2OrdersIdMetaFields 1 param body → 204401403422
GET
/api/v2/orders/{id}/order_documents
List all order documents for an order
GetApiV2OrdersIdOrderDocuments 8 params → 200401403
POST
/api/v2/orders/{id}/order_documents
Create an order document for an order
PostApiV2OrdersIdOrderDocuments 1 param body → 201401403409422
GET
/api/v2/orders/{id}/order_documents/count
Count all order documents for an order
GetApiV2OrdersIdOrderDocumentsCount 2 params → 200401403
GET
/api/v2/orders/{id}/order_items
List all order items for an order
GetApiV2OrdersIdOrderItems 8 params → 200401403
POST
/api/v2/orders/{id}/order_items
Create an order item
PostApiV2OrdersIdOrderItems 1 param body → 201401403409422
GET
/api/v2/orders/{id}/order_items/count
Count order items
GetApiV2OrdersIdOrderItemsCount 2 params → 200401403
GET
/api/v2/orders/{id}/serial_numbers
List all serial numbers associated with an order item
GetApiV2OrdersIdSerialNumbers 1 param → 200401403
GET
/api/v2/orders/{id}/shipping_documents
List shipping documents for a order
GetApiV2OrdersIdShippingDocuments 8 params → 200401403
GET
/api/v2/orders/{id}/suggested_items
Retrieve suggested items for an order
GetApiV2OrdersIdSuggestedItems 8 params → 200401403
GET
/api/v2/orders/{id}/wholesale
Retrieve the Wholesale object for an order
GetApiV2OrdersIdWholesale 1 param → 200401403

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesOrder (126 properties), PostApiV2OrdersRequest (98 properties), PutApiV2OrdersIdRequest (94 properties), ApiV2EntitiesOrderItem (31 properties). Each schema is shown below with its type and property counts.

PutApiV2OrdersIdCallActionRequest
object
2 properties
ApiV2EntitiesWholesale
object
30 properties
ApiV2EntitiesOrderEvent
object
6 properties
ApiV2EntitiesFilterSet
object
18 properties
ApiV2EntitiesWholesaleItem
object
24 properties
ApiSharedEntitiesMetaFields
object
2 properties
PostApiV2OrdersBulkRequest
object
1 property 1 required
ApiV2EntitiesOrder
object
126 properties
PutApiV2OrdersIdRequest
object
94 properties
ApiV2EntitiesPackingRule
object
13 properties
ApiV2EntitiesCount
object
1 property
PostApiV2OrdersIdOrderItemsRequest
object
27 properties 1 required
ApiV2EntitiesShippingMethod
object
16 properties
ApiV2EntitiesResult
object
1 property
PostApiV2OrdersIdOrderDocumentsRequest
object
3 properties 1 required
PostApiV2OrdersRequest
object
98 properties
ApiV2EntitiesOriginator
object
18 properties
ApiV2EntitiesShippingDocument
object
13 properties
ApiV2EntitiesOrderItem
object
31 properties
ApiV2EntitiesOrderDocument
object
7 properties
ApiV2EntitiesSerialNumber
object
5 properties
ApiV2EntitiesCustomsInfo
object
15 properties
ApiSharedEntitiesApiError
object
1 property
ApiV2EntitiesPackage
object
28 properties
PutApiV2OrdersIdMetaFieldsRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-orders-api-openapi.yml Raw ↑

Other APIs Whiplash Merchandising publishes across the network.

Whiplash Merchandising bundle_items API
Whiplash Merchandising consumer_returns API
Whiplash Merchandising customers API
Whiplash Merchandising documents API
Whiplash Merchandising items API
Whiplash Merchandising load_scacs API
Whiplash Merchandising notification_events API
Whiplash Merchandising notification_subscriptions API
Whiplash Merchandising order_documents API
Whiplash Merchandising order_items API
Whiplash Merchandising order_totes API
Whiplash Merchandising originators API