DEV3 Shipdrop REST API
Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_… · OpenAPI 3.1 JSON
/api/v1/mescope: readThe store this key belongs to
/api/v1/usagescope: readUsage for the current billing period
/api/v1/membersscope: readList staff members
Parameters: role (query)
/api/v1/network/productsscope: readBrowse the supplier network
Parameters: q (query), category (query), limit (query), page (query)
/api/v1/network/products/{id}/importscope: writeImport a network product (idempotent)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}/api/v1/productsscope: readList imported products
Parameters: status (query), limit (query), page (query)
/api/v1/products/{id}scope: readGet a product
Parameters: id (path)
/api/v1/products/{id}scope: writeUpdate title, status or a variant price
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"archived"
]
},
"variants": {
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"price": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"priceRule": {
"type": "string",
"enum": [
"auto",
"manual"
]
}
},
"required": [
"id",
"price"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}/api/v1/ordersscope: readList orders
Parameters: status (query), payment (query), routing (query), limit (query), page (query)
/api/v1/orders/{id}scope: readGet an order with its lines and supplier orders
Parameters: id (path)
/api/v1/orders/{id}/refundscope: writeRefund an order or lines of it (amount in minor units)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"amount": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"lines": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"variantId": {
"type": "string"
},
"qty": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"variantId",
"qty"
],
"additionalProperties": false
}
},
"fault": {
"default": "merchant",
"type": "string",
"enum": [
"merchant",
"supplier",
"customer"
]
},
"reason": {
"type": "string",
"maxLength": 200
}
},
"required": [
"fault"
],
"additionalProperties": false
}/api/v1/supplier-ordersscope: readList supplier orders
Parameters: status (query), limit (query)
/api/v1/balancescope: readPending, available and reserve balance
/api/v1/payoutsscope: readPayout requests
/api/v1/returnsscope: readList return requests (RMAs)
Parameters: status (query), limit (query)
/api/v1/reports/{key}scope: readRun a report from the library (dates are inclusive, UTC)
Parameters: key (path), from (query), to (query), groupBy (query), channel (query), country (query)