How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Whiplash Consumer Returns API

Goods returning from end consumers — list, create (single/bulk), count, retrieve, update, destroy, and meta fields

Whiplash Consumer Returns API is one of 10 APIs that Whiplash 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, authentication docs, and rate-limit docs.

This API exposes 8 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://api.getwhiplash.com.

8 operations 5 paths 4 schemas 1 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://api.getwhiplash.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Whiplash Consumer Returns API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth2) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token. Obtain via authorization code or client credentials flow. See https://help.whiplash.com/hc/en-us/articles/360050870691-Authentication-f…

Paths & Operations 8

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

Consumer Returns 8

Goods returning from end consumers — list, create (single/bulk), count, retrieve, update, destroy, and meta fields

GET
/v2/consumer_returns
List consumer returns
listConsumerReturns 2 params → 200401
POST
/v2/consumer_returns
Create a consumer return
createConsumerReturn body → 201401422
POST
/v2/consumer_returns/bulk
Bulk create consumer returns
bulkCreateConsumerReturns body → 201401
GET
/v2/consumer_returns/count
Count consumer returns
countConsumerReturns → 200401
GET
/v2/consumer_returns/{id}
Retrieve a consumer return
getConsumerReturn 1 param → 200401404
PUT
/v2/consumer_returns/{id}
Update a consumer return
updateConsumerReturn 1 param body → 200401404
DELETE
/v2/consumer_returns/{id}
Delete a consumer return
deleteConsumerReturn 1 param → 204401404
GET
/v2/consumer_returns/{id}/meta_fields
List meta fields for a consumer return
listConsumerReturnMetaFields 1 param → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ConsumerReturnInput (4 properties), CustomField (2 properties), CountResponse (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
CustomField
object
2 properties 2 required
ConsumerReturnInput
object
4 properties
CountResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Whiplash publishes across the network.

Whiplash Bundle Items API
Whiplash Customers API
Whiplash Documents API
Whiplash Items API
Whiplash Notification Events API
Whiplash Notification Subscriptions API
Whiplash Orders API
Whiplash Shipnotices API
Whiplash Simulate API
Where this information came from

This is an independent, third-party profile of Whiplash Consumer Returns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.