DEV3 Shipdrop
Sign inStart free

DEV3 Shipdrop REST API

Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_… · OpenAPI 3.1 JSON

get/api/v1/mescope: read

The store this key belongs to

get/api/v1/usagescope: read

Usage for the current billing period

get/api/v1/membersscope: read

List staff members

Parameters: role (query)

get/api/v1/network/productsscope: read

Browse the supplier network

Parameters: q (query), category (query), limit (query), page (query)

post/api/v1/network/products/{id}/importscope: write

Import a network product (idempotent)

Parameters: id (path)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}
get/api/v1/productsscope: read

List imported products

Parameters: status (query), limit (query), page (query)

get/api/v1/products/{id}scope: read

Get a product

Parameters: id (path)

patch/api/v1/products/{id}scope: write

Update 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
}
get/api/v1/ordersscope: read

List orders

Parameters: status (query), payment (query), routing (query), limit (query), page (query)

get/api/v1/orders/{id}scope: read

Get an order with its lines and supplier orders

Parameters: id (path)

post/api/v1/orders/{id}/refundscope: write

Refund 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
}
get/api/v1/supplier-ordersscope: read

List supplier orders

Parameters: status (query), limit (query)

get/api/v1/balancescope: read

Pending, available and reserve balance

get/api/v1/payoutsscope: read

Payout requests

get/api/v1/returnsscope: read

List return requests (RMAs)

Parameters: status (query), limit (query)

get/api/v1/reports/{key}scope: read

Run a report from the library (dates are inclusive, UTC)

Parameters: key (path), from (query), to (query), groupBy (query), channel (query), country (query)