Download OpenAPI specification:Download
API Documentation for communicating with the SPY System.
This document will describe how developers can authenticate and communicate with the SPY System API.
We're using Swagger to generate and publish an OpenAPI Specification (OAS) document for the [SPY System API] which is compatible with tools like Swagger, Open API Generator, Postman that are used for viewing and testing resources before putting them in your codebase. Also for generating client libraries in php, ruby, python, go, csharp and a lot more.
Once the order is created it will be imported into the SPY System. Here it will be waiting to be packed. Once packed a webhook event will tell the api user the order has been packed and needs to be accepted before being send.
At this point the status for the delivery is pending.
By changing the delivery status to accepted, will notice the spy system that it is ok for being delivered and invoiced.
By changing the status to rejected will cancel the delivery and make it immutable. A new delivery is required for it to being delivered (NOT a new order).
It is possible to change status from accepted to pending and vice versa, but rejected is locking it.
{- "status": 0,
- "message": "string",
- "data": {
- "count": 0,
- "brands": [
- {
- "brandName": "string"
}
]
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "count": 0,
- "freightOptions": [
- {
- "freightType": "string"
}
]
}
}
Create Order
required | object (ShippingAddress) |
required | Array of objects (OrderLineItem) |
reference required | string |
comment | string |
required | object (Freight) |
{- "shippingAddress": {
- "address": "string",
- "address2": "string",
- "city": "string",
- "company": "string",
- "country": "string",
- "countryCode": "string",
- "firstName": "string",
- "lastName": "string",
- "phone": "string",
- "email": "string",
- "provinceCode": "string",
- "zip": "string"
}, - "orderLineItems": [
- {
- "barcode": "string",
- "quantity": 0,
- "price": 0
}
], - "reference": "string",
- "comment": "string",
- "freight": {
- "freightAmount": 0,
- "freightType": "string",
- "parcelShopId": "string",
- "warehouseCode": "string"
}
}
{- "status": 0,
- "message": "string",
- "data": {
- "orderId": 0,
- "orderStatus": "string"
}
}
List Variants
brandName required | string |
styleNo | string |
{- "status": 0,
- "message": "string",
- "data": {
- "count": 0,
- "variants": [
- {
- "barcode": "string",
- "variantType": "size",
- "styleNo": "string",
- "brandName": "string",
- "styleName": "string",
- "styleNameWebshop": "string",
- "colorName": "string",
- "size": "string",
- "quantity": 0,
- "price": 0,
- "priceOriginal": 0,
- "wspPrice": 0,
- "currency": "string",
- "styleDescription": "string",
- "wash": "string",
- "category": "string",
- "quality": "string",
- "type": "string",
- "gender": "string",
- "images": [
- "string"
], - "b2bHidden": true,
- "colorActive": true,
- "tags": "string",
- "customsTariffNumber": "string",
- "countryOfOrigin": "string",
- "weight": 0,
- "seasonName": "string"
}
]
}
}
List Variant based on Barcode
barcode required | string |
brandName required | string |
{- "status": 0,
- "message": "string",
- "data": {
- "variant": {
- "barcode": "string",
- "variantType": "size",
- "styleNo": "string",
- "brandName": "string",
- "styleName": "string",
- "styleNameWebshop": "string",
- "colorName": "string",
- "size": "string",
- "quantity": 0,
- "price": 0,
- "priceOriginal": 0,
- "wspPrice": 0,
- "currency": "string",
- "styleDescription": "string",
- "wash": "string",
- "category": "string",
- "quality": "string",
- "type": "string",
- "gender": "string",
- "images": [
- "string"
], - "b2bHidden": true,
- "colorActive": true,
- "tags": "string",
- "customsTariffNumber": "string",
- "countryOfOrigin": "string",
- "weight": 0,
- "seasonName": "string"
}
}
}
List Deliveries
from | string From Date |
to | string To Date |
{- "status": 0,
- "message": "string",
- "data": {
- "count": 0,
- "deliveries": [
- {
- "deliveryNo": "string",
- "status": "string",
- "variants": [
- {
- "barcode": "string",
- "variantType": "size",
- "styleNo": "string",
- "brandName": "string",
- "styleName": "string",
- "styleNameWebshop": "string",
- "colorName": "string",
- "size": "string",
- "quantity": 0,
- "price": 0,
- "priceOriginal": 0,
- "wspPrice": 0,
- "currency": "string",
- "styleDescription": "string",
- "wash": "string",
- "category": "string",
- "quality": "string",
- "type": "string",
- "gender": "string",
- "images": [
- "string"
], - "b2bHidden": true,
- "colorActive": true,
- "tags": "string",
- "customsTariffNumber": "string",
- "countryOfOrigin": "string",
- "weight": 0,
- "seasonName": "string"
}
], - "trackAndTrace": [
- {
- "trackingNumbers": [
- "string"
], - "trackingLinks": [
- "string"
]
}
]
}
]
}
}
Delivery Status
deliveryNo required | string |
status required | string Enum: "pending" "accepted" "rejected" |
{- "status": "pending"
}
{- "status": 0,
- "message": "string",
- "data": {
- "deliveryNo": "string",
- "status": "pending"
}
}
Delivery Details
deliveryNo required | string |
{- "status": 0,
- "message": "string",
- "data": {
- "delivery": {
- "deliveryNo": "string",
- "status": "string",
- "variants": [
- {
- "barcode": "string",
- "variantType": "size",
- "styleNo": "string",
- "brandName": "string",
- "styleName": "string",
- "styleNameWebshop": "string",
- "colorName": "string",
- "size": "string",
- "quantity": 0,
- "price": 0,
- "priceOriginal": 0,
- "wspPrice": 0,
- "currency": "string",
- "styleDescription": "string",
- "wash": "string",
- "category": "string",
- "quality": "string",
- "type": "string",
- "gender": "string",
- "images": [
- "string"
], - "b2bHidden": true,
- "colorActive": true,
- "tags": "string",
- "customsTariffNumber": "string",
- "countryOfOrigin": "string",
- "weight": 0,
- "seasonName": "string"
}
], - "trackAndTrace": [
- {
- "trackingNumbers": [
- "string"
], - "trackingLinks": [
- "string"
]
}
]
}
}
}