v3.0.0 released bringing a lot of changes
Below a summary of the changes from v2 API to v3
Authentication
We changed the way to authenticate from using a PAT (personal access token) to OAuth. You will need a clientID and clientSecret to get an access token (expires after 1 hour). You can use this access token to authorize your API calls. More info here.
Common (for all models)
All enum-values are now lower case (f.a. outbound status 'FULLY_SHIPPED' now is 'fully_shipped')
Product / Variant changes
Variants do not exist anymore, we only have products now. That means that every "v2 variant" should now be a (v3-)product with a unique sku. The corresponding variant endpoints are removed.
| Name | Mutation | Description |
|---|
| sku | Added | Unique stock keeping unit SKU for the product (moved from variant) |
| barcode | Added | The scannable barcode of the product (moved from variant) |
| width | Added | The width of the product in millimeters (moved from variant) |
| height | Added | The height of the product in millimeters (moved from variant) |
| length | Added | The length of the product in millimeters (moved from variant) |
| weight | Added | The weight of the product in millimeters (moved from variant) |
| stock | Added | readonly, moved from variant |
| ref | Removed | Removed replaced by sku |
| variants | Removed | Variants are removed |
Outbound changes
| Name | Mutation | Description |
|---|
| shipmentMethodCode | Added | Tell us how you want us to ship this outbound. Valid values can be found in your partner portal under settings/shipping. |
| shipping | Removed | Replaced by shipmentMethodCode |
| shipToCity | Modified | Max length now is 30 characters |
| shippingContactCity | Modified | Max length now is 30 characters |
OutboundLine changes
| Name | Mutation | Description |
|---|
| sku | Added | Unique reference to the product by sku |
| variantRef | Removed | Replaced by sku |
ShipmentLine changes
| Name | Mutation | Description |
|---|
| sku | Added | Unique reference to the product by sku |
| variantRef | Removed | Replaced by sku |
InboundLine changes
| Name | Mutation | Description |
|---|
| ref | Added | Unique reference that identifies the inboundLine |
| sku | Added | Unique reference to the product by sku |
| sequence | Removed | Replaced by ref |
| variantRef | Removed | Replaced by sku |
ReceiptLine changes
| Name | Mutation | Description |
|---|
| inboundLineRef | Added | Unique reference that identifies the inboundLine |
| sku | Added | Unique reference to the product by sku |
| inboundLineSequence | Removed | Replaced by inboundLineRef |
| variantRef | Removed | Replaced by sku |
