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 consumer_returns API

A ConsumerReturn represents goods coming back from an end consumer. It is a special form of Shipnotice, and is processed in much the same way.

Whiplash Merchandising consumer_returns 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 consumer_returns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 5 paths, and defines 21 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.

9 operations 5 paths 21 schemas 1 DELETE4 GET2 POST2 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 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

consumer_returns 9

A ConsumerReturn represents goods coming back from an end consumer. It is a special form of Shipnotice, and is processed in much the same way.

GET
/api/v2/consumer_returns
List all consumer returns
GetApiV2ConsumerReturns 7 params → 200401403
POST
/api/v2/consumer_returns
Create a consumer return
PostApiV2ConsumerReturns body → 201401403409422
POST
/api/v2/consumer_returns/bulk
Create consumerreturns in bulk
PostApiV2ConsumerReturnsBulk body → 201401403409422
GET
/api/v2/consumer_returns/count
Count consumer returns
GetApiV2ConsumerReturnsCount 1 param → 200401403
GET
/api/v2/consumer_returns/{id}
Retrieve a consumer return
GetApiV2ConsumerReturnsId 1 param → 200401403
PUT
/api/v2/consumer_returns/{id}
Update a consumer return
PutApiV2ConsumerReturnsId 1 param body → 200401403422
DELETE
/api/v2/consumer_returns/{id}
Destroy a consumer return
DeleteApiV2ConsumerReturnsId 1 param → 204401403422
GET
/api/v2/consumer_returns/{id}/meta_fields
List meta fields
GetApiV2ConsumerReturnsIdMetaFields 2 params → 200401403
PUT
/api/v2/consumer_returns/{id}/meta_fields
Set meta fields
PutApiV2ConsumerReturnsIdMetaFields 1 param body → 204401403422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesOrder (126 properties), ApiV2EntitiesCustomerShallow (83 properties), ApiV2EntitiesWarehouseShallow (46 properties), ApiV2EntitiesWarehouse (45 properties). Each schema is shown below with its type and property counts.

ApiV2EntitiesReturnItem
object
16 properties
ApiV2EntitiesWholesaleItem
object
24 properties
ApiSharedEntitiesMetaFields
object
2 properties
PutApiV2ConsumerReturnsIdMetaFieldsRequest
object
2 properties
ApiV2EntitiesConsumerReturn
object
40 properties
ApiV2EntitiesOrder
object
126 properties
ApiV2EntitiesWarehouseShallow
object
46 properties
ApiV2EntitiesWarehouse
object
45 properties
ApiV2EntitiesCount
object
1 property
ApiV2EntitiesShippingMethod
object
16 properties
ApiV2EntitiesResult
object
1 property
PostApiV2ConsumerReturnsRequest
object
36 properties 2 required
ApiV2EntitiesCustomerShallow
object
83 properties
ApiV2EntitiesOriginator
object
18 properties
ApiV2EntitiesWarehouseFeature
object
6 properties
ApiV2EntitiesOrderItem
object
31 properties
PostApiV2ConsumerReturnsBulkRequest
object
1 property 1 required
ApiV2EntitiesSerialNumber
object
5 properties
ApiSharedEntitiesApiError
object
1 property
PutApiV2ConsumerReturnsIdRequest
object
11 properties
ApiV2EntitiesPackage
object
28 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-consumer-returns-api-openapi.yml Raw ↑

Other APIs Whiplash Merchandising publishes across the network.

Whiplash Merchandising bundle_items 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 orders API
Whiplash Merchandising originators API