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

Customers are Whiplash clients, not the End Consumer. Most Whiplash resources are owned by a Customer (or belong to resources that are).

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

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

5 operations 4 paths 6 schemas 4 GET1 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 5

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

customers 5

Customers are Whiplash clients, not the End Consumer. Most Whiplash resources are owned by a Customer (or belong to resources that are).

GET
/api/v2/customers
List all customers
GetApiV2Customers 7 params → 200401403
GET
/api/v2/customers/actions
List actions you can perform
GetApiV2CustomersActions → 401403
GET
/api/v2/customers/count
Count customers
GetApiV2CustomersCount 1 param → 200401403
GET
/api/v2/customers/{id}
Retrieve a customer
GetApiV2CustomersId 1 param → 200401403
PUT
/api/v2/customers/{id}
Update a customer
PutApiV2CustomersId 1 param body → 200401403422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesCustomer (101 properties), PutApiV2CustomersIdRequest (96 properties), ApiV2EntitiesWarehouse (45 properties), ApiV2EntitiesWarehouseFeature (6 properties). Each schema is shown below with its type and property counts.

ApiSharedEntitiesApiError
object
1 property
ApiV2EntitiesCustomer
object
101 properties
ApiV2EntitiesWarehouse
object
45 properties
ApiV2EntitiesCount
object
1 property
ApiV2EntitiesWarehouseFeature
object
6 properties
PutApiV2CustomersIdRequest
object
96 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Whiplash Merchandising publishes across the network.

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