{"info":{"_postman_id":"92583e97-fc4c-d52b-2457-6107bc6302fc","name":"StylusOP Vendor API Documentation - v2.9.8","description":"

Welcome to the StylusOP API official documentation.
This documentation is useful to you if you are a vendor and want to integrate with our fulfillment system.

Integrating a new vendor involves some manual setup before the vendor can start consuming our API
This integration process involves:

Create the new vendor inside the STYLUS OP system
\n
Generate vendorId and API authentication token for the created vendor
\n
Product setup - Manual process when the vendor and the fulfiller (us) agree on what products will be fulfilled. Any product related details will be shared at this stage.
\n
API integration - The vendor is ready to consume our API.
\n

Getting Started

Our API tries to follow the RESTful standard. If you are familiar with RESTful API's, then following along should be fairly easy.
We support different request methods such as GET,POST,PATCH and PUT

The contents of this documentation will cover different topics such as:

Authentication
\n
Pushing/posting orders for production
\n
Listing your existing orders
\n
Tracking an order's status
\n
Cancelling an order
\n
Updating an order:
\n
- Updating the line-items
  \n
- Updating the artwork images
  \n
- Updating the customer and shipping related data
  \n
\n
Receiving status update notifications via callback url
\n
NEW: Get order's activity log and events
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Term	Description
Vendor	The consumer of our api. This would be you
Fulfiller	This would be us
Token	A hashed text string. This term will be mainly used in terms of authentication
Artwork	The image file(s) for us to print and fulfill.

Usage Guidelines

All requests made to the production endpoint are done via HTTPs. Requests via insecure HTTP are not supported in production environment.
\n
All requests submitted to the API is structured in JSON, so the content-type should be: application/json
\n
Date/time values returned by the API are in UTC unless stated otherwise.
\n
{variable} in URLs should be substituted with the proper variable value.
\n

Endpoints

The endpoints will depend on the environment. There are 2 environments available to you:

\n
Production -- Our live environment. Not to be used for making test requests
Staging -- Must be used during development (Sandbox)
\n

Base Url:

https://stylusopapi-prod.stylusapparel.com/api/v2/  (production)\nhttps://stylusopapi-staging.stylusapparel.com/api/v2/ (staging)\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Supported Methods	Description
/orders/vendor/{vendorId}	GET, POST, PATCH	Endpoint for order creation, getting orders and updating an order
/orders/{orderId}/vendor/{vendorId}	GET	Retrieves an specific order by supplying its orderId.
/orders/{orderId}/status/vendor/{vendorId}	GET	Will return the specific order's production status only. If you are only interested on getting the status of an order, then we strongly recommend using this endpoint instead of /orders/{orderId}. Doing so will save you some bandwidth specially if you are planning on fetching the status of an order frequently
/orders/{orderId}/activity/vendor/{vendorId}	GET	Get the order's latest activity. As of now, a maximum of 100 entries are returned per page.
/orders/{orderId}/cancel/vendor/{vendorId}	POST	Cancel an order / line-item(s).
/products/vendor/{vendorId}	GET	List all the vendor's linked products
/stock/sku/{variantSku}/vendor/{vendorId}	GET	Get the product variant's stock levels

Authentication

To use our API, you will have to make authenticated requests by using either Bearer Token or Basic Auth method as follows:

\"Authorization\": Bearer {authToken}    (Bearer)\n\n

 \"Authorization\": Basic {apiSecret}    (Basic)\n\n

\n
Note: The authentication token will be provided by us manually. There is automated way for you to create or refresh the token yourself.
\n

HTTP Response Codes

Our API will respond to your requests with either of the following http codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Type	Description
200	Success	General successful response
201	Created	The order has been created successfully in our system
204	Success No-Content	Successful response without a response body
400	Bad Request	Invalid payload
401	Unauthorized	Failed to provide valid authentication
403	Forbidden	Not allowed to consume the resource
404	Not Found	The resource is not found
408	Timeout	Request has taken too long to be processed
409	Conflict	Request creates a conflict with the target resource. Used as error status code for \"OrderDuplicate\" error (The resource already exists in our system)
422	Unprocessable Entity	Request is understood however we couldn't process it
500	Internal Error	An error occurred on our end while processing your request
503	Unavailable	The API is temporarily down for scheduled maintenance

Error Handling

In order to properly handle errors returned by the API, the Stylus API defines a set of error codes that are included in the response whenever an error occurs.
Please make sure your application is aware of these error codes.

An example of an error response would look like this:

{   \n    \"success\": false,\n    \"message\": \"Error creating new order: ApiError: Payload didn't include the required fields\",\n    \"errorCode\": \"InvalidPayload\",\n    \"rawError\": \"\" // the error stack here. (Not available in Production environment)\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Endpoint	Description
`OrderDuplicate`	Create	Order or order line-item already exists. Note that we validate for order duplicates by the \"itemNumber\" rather than the \"orderId\"
`WrongLineItemProperties`	Create, Update	When error is related to line-item properties, incorrect values or not properly formattted. E.g passing a \"size\" property that's not supported by the product
`InvalidPayload`	Create, Update	When the payload is missing required fields, fields not properly formatted, etc
`ProductNotFound`	Create, Update	When product included in the line-items array is not found in the system
`StatusIssue`	Update, Cancel	when order or line-item status is too far in production for it to be updated
`ItemSkuIssue`	Create, Update	When sku in line-item is incorrect or not properly formatted
`WrongLineItem`	Cancel	When one or more line-items defined in the \"items\" array does not belong to the order

API Models

Model - Order

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Required	Description
`orderKey`	string	Read-Only	The internal unique identifier for the order. This is a read-only field.
`orderId`	number	Required	The user-defined identifier for the order. This is a read-only field.
`orderStatus`	string	Read-Only	The status of the order. This is a read-only field. Possible values: `ordered`,`printed`, `picked`,`shipped`, `cancelled`, `voided`, `completed`, `delayed`, `error`.
`callbackUri`	string	Optional	A user-defined url for us to send Status Update Notifications to. It allows the vendor to receive updates on the status of an order during production
`companyRefId`	string	Required	The vendor's username.
`customerName` (deprecated)	string	Optional	This field has been marked for deprecation in favor of the \"shippingInfo.name\" field.
`shippingInfo`	Address	Required	The customer's shipping address. Please check the Address model for reference of these values.
`returnToAddress`	Address	Optional	Allows a \"Return to address\" or \"Ship from location\" to be specified. This is particularly useful when creating shipping labels to indicate we want the goods to be returned to a particular location. Vendors may use this option to specify their own warehouse locations
`shippingMethod`	string	Optional	User defined shipping method. Values could be 'standard' or 'express'
`created_date`	string	Read-Only	The timestamp the order was created in our database. Read-Only.
`sale_datetime`	string	Optional	The user-provided timestamp the order was purchased.
`items`	[LineItem[]]	Required	Array of purchased order line-items. Please refer to the LineItem model.
`artworksInOrder`	[Artwork[]]	Read-Only	An array of the artwork images defined inside this order. Please refer to the Artwork model.
`packingSheetUrl`	string	Optional	A user-defined public url used for providing your own custom packing sheet. If specified, we will use this document during packing and shipping.
`cancelledAt`	string	Read-Only	Specifies the datetime when the entire order was cancelled

Model - Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Required	Description
`name`	string	Required	The customer's full name. This value can be updated by the vendor later on.
`company`	string	Optional	The company's name. Useful when using inside \"returnToAddress\".
`email`	string	Optional	The customer's email.
`street1`	string	Required	The shipping address street 1.
`street2`	string	Optional	Additional address or reference
`city`	string	Required	The shipping address' city.
`state`	string	Required	The shipping address' state / province. UPDATE: This field might not be required for countries that don't support states
`phone`	string	Optional	The customer's phone number
`postcode`	string	Required	The shipping address' postal code. UPDATE: This field might not be required for countries that don't support states
`country_code`	string	Required	The shipping address's country code. E.g: 'US', 'CA', 'AU'.

Model - LineItem[]

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Required	Description
`itemId`	number	Read-only	The internal identifier for the line-item in our system. This is a read-only field.
`itemNumber`	number	Required	The user-defined identifier for the line-item.
`product`	string	Required	The product type. For instance: `legging`,`capri`, `scarf`,`hoodie`. The value of this property will be discussed with us during integration.
`properties`	ItemProperties	Optional	A user-defined set of properties that includes data such as product color, size. Please refer to the ItemProperties model
`sku`	string	Required	A user-defined sku for the line-item
`previewImgUrl`	string	Optional	A catalog-style image thumbnail for this product item.
`assets`	Assets[]	Required	An array of artwork images for this specific line-item. Please refer to the Assets[] model.
`quantity`	number	Required	The quantity for this line-item. This will reflect on how many prints we do of the artworks defined inside \"assets\"
`price`	number	Required	A user-defined unit price for this line-item. Please be aware that this is unit price, meaning, it should NOT be computed with the item quantity.
`weight`	ItemWeight	Read-Only	An object with data about the item's weight. Please refer to the ItemWeight model.

Model - ItemProperties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Required	Description
`size`	string	Optional	The size of the line-item if applicable. Defaults to \"OS\", which stands for \"One Size\".
`color`	string	Optional	The color of the line-item if applicable. Defaults to \"OS\".

Model - Assets[]

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Required	Description
`description`	string	Optional	A small description of the artwork file. Important!: When line-item has multiple sides defined in \"assets\", then use this field to specify the \"side\" name or id. Ie: \"front\", \"back\", \"left-sleeve\", etc.
`url`	string	Required	A public or pre-authenticated url of the artwork image file in full size.
`preview_url`	string	Optional	A public or pre-authenticated url of a thumbnail of the artwork image file, if available.

Model - ItemWeight

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Data Type	Required	Description
`value`	number	Read-Only	The weight value of the product.
`units`	string	Optional	The measuring unit system of the weight value. Ie: 'oz', 'lb'.

API Deprecation

When an API endpoint is scheduled for deprecation the following actions will be taken:

The endpoint documentation will be marked as deprecated and a migration plan will be added.
\n
The endpoint will have a Sunset header (Sunset HTTP Header) added to indicate the last date the endpoint should be relied upon.
\n
A email will be sent to active third party developers notifying of the deprecation.
\n
A entry to the API changelog will be added.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"},{"content":"Usage Guidelines","slug":"usage-guidelines"},{"content":"Endpoints","slug":"endpoints"},{"content":"Authentication","slug":"authentication"},{"content":"HTTP Response Codes","slug":"http-response-codes"},{"content":"API Models","slug":"api-models"}],"owner":"355529","collectionId":"92583e97-fc4c-d52b-2457-6107bc6302fc","publishedId":"RW81tCh5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-06-01T17:10:34.000Z"},"item":[{"name":"Auth API","item":[{"name":"Check Token","id":"008ad1ba-0870-a469-6668-d2ffd61d2fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/auth/check-token?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YjMzNTNmZWQ0MjIzNDEzMTBhYzZlN2YiLCJyb2xlIjoxLCJpYXQiOjE1MzcxOTIxODMsImV4cCI6MTUzOTc4NDE4M30.3u6V7mA3ZXTQ_J9IswM40vyaLuT_JpnqELGHfCBC8h0","description":"

This endpoint allows the user to check the validity of their token. Useful to check if token is expired

\n","urlObject":{"path":["{{version}}","auth","check-token"],"host":["{{baseUrl}}"],"query":[{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YjMzNTNmZWQ0MjIzNDEzMTBhYzZlN2YiLCJyb2xlIjoxLCJpYXQiOjE1MzcxOTIxODMsImV4cCI6MTUzOTc4NDE4M30.3u6V7mA3ZXTQ_J9IswM40vyaLuT_JpnqELGHfCBC8h0"}],"variable":[]}},"response":[],"_postman_id":"008ad1ba-0870-a469-6668-d2ffd61d2fe4"}],"id":"40441c28-507c-7d99-b788-353cda525c01","event":[{"listen":"prerequest","script":{"id":"9d026969-42e9-4b3a-bc3b-f2b34bc42f0d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c31c06aa-d1f5-40f0-9933-f5ff6f74b6c4","type":"text/javascript","exec":[""]}}],"_postman_id":"40441c28-507c-7d99-b788-353cda525c01","description":""},{"name":"Orders API","item":[{"name":"Create Order","id":"c7389e8b-7626-bdaf-4a30-2b8d1916c37e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"{{vendorId}}\",\n \"shippingInfo\": {\n \"name\": \"TESTING\",\n \"street1\": \"271 COLLINS STREET\",\n \"street2\": \"LEVEL 3\",\n \"city\": \"MELBOURNE\",\n \"state\": \"VIC\",\n \"phone\": \"\",\n \"postcode\": \"3000\",\n \"country_code\": \"AU\"\n },\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}","description":"

Push an order into our system

\n","urlObject":{"path":["{{version}}","orders","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"60e60b8e-49d1-4f3b-af87-bf22dca07828","name":"Create Order - Product Not Found Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"{{vendorId}}\",\n \"shippingInfo\": {\n \"name\": \"TESTING\",\n \"street1\": \"271 COLLINS STREET\",\n \"street2\": \"LEVEL 3\",\n \"city\": \"MELBOURNE\",\n \"state\": \"VIC\",\n \"phone\": \"\",\n \"postcode\": \"3000\",\n \"country_code\": \"AU\"\n },\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"product\": \"some-incorrect-product-name\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Error creating new order: The product doesn't exist\",\r\n \"errorCode\": \"ProductNotFound\"\r\n}"},{"id":"a748e7e5-6ba7-49d3-bf50-ac8299e21d31","name":"Create Order - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"xyzclothing\",\n \"shippingInfo\": {\n \"name\": \"TESTING\",\n \"street1\": \"271 COLLINS STREET\",\n \"street2\": \"LEVEL 3\",\n \"city\": \"MELBOURNE\",\n \"state\": \"VIC\",\n \"phone\": \"\",\n \"postcode\": \"3000\",\n \"country_code\": \"AU\"\n },\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"front\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n },\n {\n \"assets\": [\n {\n \"description\": \"front\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100002,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 2,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"ETag","value":"W/\"2b-ZoOx4qnaUPBtJFoiaNfDhkCxdVw\""},{"key":"Date","value":"Fri, 01 Feb 2019 19:23:45 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"reference_id\": \"5c549cc10ceff4427c37b680\"\n}"},{"id":"b3fe65cc-a34c-457d-baa5-05b583024e90","name":"Create Order - Item Property Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"{{vendorId}}\",\n \"shippingInfo\": {\n \"name\": \"TESTING\",\n \"street1\": \"271 COLLINS STREET\",\n \"street2\": \"LEVEL 3\",\n \"city\": \"MELBOURNE\",\n \"state\": \"VIC\",\n \"phone\": \"\",\n \"postcode\": \"3000\",\n \"country_code\": \"AU\"\n },\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Error creating new order: The specified size \\\"XL\\\" is not available for this product\",\n \"errorCode\": \"WrongLineItemProperties\"\n}"},{"id":"b5260a29-b3bd-42a3-928a-a1b32811815f","name":"Create Order - Wrong Product Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"{{vendorId}}\",\n \"shippingInfo\": {\n \"name\": \"TESTING\",\n \"street1\": \"271 COLLINS STREET\",\n \"street2\": \"LEVEL 3\",\n \"city\": \"MELBOURNE\",\n \"state\": \"VIC\",\n \"phone\": \"\",\n \"postcode\": \"3000\",\n \"country_code\": \"AU\"\n },\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Error creating new order: Product is not mapped to this vendor\",\n \"errorCode\": \"ProductNotFound\"\n}"},{"id":"cccbad8f-a612-409c-b5ff-a1ad389a02d6","name":"Create Order - Invalid Payload Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"{{vendorId}}\",\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"success\": false,\r\n \"message\": \"Error creating new order: Payload didn't include the required fields\",\r\n \"errorCode\": \"InvalidPayload\"\r\n}"},{"id":"e3d1be66-3c3f-4c8f-9ab4-6483f9143176","name":"Create Order - Item Sku Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 123456789,\n \"companyRefId\": \"{{vendorId}}\",\n \"shippingInfo\": {\n \"name\": \"TESTING\",\n \"street1\": \"271 COLLINS STREET\",\n \"street2\": \"LEVEL 3\",\n \"city\": \"MELBOURNE\",\n \"state\": \"VIC\",\n \"phone\": \"\",\n \"postcode\": \"3000\",\n \"country_code\": \"AU\"\n },\n \"shippingMethod\": \"standard\",\n \"items\": [\n {\n \"assets\": [\n {\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19934L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\"\n }\n ],\n \"itemNumber\": 100001,\n \"sku\": \"SUKA105\",\n \"properties\": {\n \"size\": \"XL\",\n \"color\": \"black\"\n },\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19934L.png\",\n \"quantity\": 1,\n \"price\": 1.99\n }\n ],\n \"sale_datetime\": \"2018-07-03T00:00:00.130Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Error creating new order: The specified sku is invalid / not properly formatted\",\n \"errorCode\": \"ItemSkuIssue\"\n}"}],"_postman_id":"c7389e8b-7626-bdaf-4a30-2b8d1916c37e"},{"name":"Cancel Order","id":"fbe3ff1c-c179-4c84-a9b3-a549b4ed0dc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n\t\"items\": [\n \t100001,\n \t100002,\n \t100003\n ],\n \"reason\": \"Customer requested chargeback\"\n}"},"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/cancel/vendor/{{vendorId}}","description":"

Cancel an active order or order's line-items

\n","urlObject":{"path":["{{version}}","orders","{{orderId}}","cancel","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"b0b13c67-3415-4ece-89a5-7cc90670a842","name":"Cancel Order - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n\t\"items\": [\n \t100001,\n \t100002,\n \t100003\n ],\n \"reason\": \"Customer requested chargeback\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/cancel/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"success\": true,\n\t\"message\": \"Cancelled order\"\n}"},{"id":"d28da17b-c650-47f1-8858-94b41fc9ac2a","name":"Cancel Order - Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Yjg3NjE2ZGQ1YmI1ZjAwMDQ1ZDA0ZGMiLCJyb2xlIjozLCJpYXQiOjE1NDM0MTcwODcsImV4cCI6MTY5ODkzNzA4N30.dHKajjSh9h4Ktzi3KVGeMOHpFfzITDW423j8ZgWdPz8"}],"body":{"mode":"raw","raw":"{\n\t\"items\": [\n \t100001,\n \t100002,\n \t100003\n ],\n \"reason\": \"Customer requested chargeback\"\n}"},"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/cancel/vendor/{{vendorId}}"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"success\": false,\n\t\"error\": \"Error cancelling the order. Order line-items cannot be cancelled: Order has already been printed. Please contact customer support for further assistance\"\n}"}],"_postman_id":"fbe3ff1c-c179-4c84-a9b3-a549b4ed0dc4"},{"name":"Get Orders","id":"b380e521-4229-aa4c-d405-d87173dd0448","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {yourToken}","description":"

Replace with your API token

\n"}],"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}","description":"

Get all your orders

\n","urlObject":{"path":["{{version}}","orders","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"4f3007a1-1356-40ec-8921-0e674f3d9237","name":"Get Orders - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {yourToken}","description":"Replace with your API token"}],"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"success\": true,\r\n \"message\": \"Successfully retrieved orders\",\r\n \"orders\": [\r\n {\r\n \"_id\": \"5f03046e84ecc9520290bd50\",\r\n \"orderStatus\": \"printed\",\r\n \"orderId\": \"2500001103640763629\",\r\n \"shippingInfo\": {\r\n \"name\": \"Janet A Manning\",\r\n \"street1\": \"35 HICKORY HILL RD\",\r\n \"street2\": null,\r\n \"city\": \"EASTCHESTER\",\r\n \"state\": \"NY\",\r\n \"phone\": \"9147797554\",\r\n \"postcode\": \"10709-1453\",\r\n \"country_code\": \"us\"\r\n }\r\n },\r\n {\r\n \"_id\": \"5f03205184ecc9520290bda7\",\r\n \"orderStatus\": \"printed\",\r\n \"orderId\": \"2500001101484630105\",\r\n \"shippingInfo\": {\r\n \"name\": \"Joel Iams\",\r\n \"street1\": \"1224 DALE DR\",\r\n \"street2\": null,\r\n \"city\": \"SILVER SPRING\",\r\n \"state\": \"MD\",\r\n \"phone\": \"3015649537\",\r\n \"postcode\": \"20910-1609\",\r\n \"country_code\": \"us\"\r\n }\r\n },\r\n {\r\n \"_id\": \"5f032e6584ecc9520290bdb7\",\r\n \"orderStatus\": \"printed\",\r\n \"orderId\": \"2500001103219386097\",\r\n \"shippingInfo\": {\r\n \"name\": \"Dana Walker\",\r\n \"street1\": \"7014 BUCHANAN RD\",\r\n \"street2\": null,\r\n \"city\": \"TEMPLE HILLS\",\r\n \"state\": \"MD\",\r\n \"phone\": \"3012045563\",\r\n \"postcode\": \"20748-5322\",\r\n \"country_code\": \"us\"\r\n }\r\n }\r\n ]\r\n}"},{"id":"cf14d3b7-9f13-4f64-8e26-efe24a6eac46","name":"Get Orders - Empty Results","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {yourToken}","description":"Replace with your API token"}],"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"No orders found\",\n \"orders\": []\n}"}],"_postman_id":"b380e521-4229-aa4c-d405-d87173dd0448"},{"name":"Get Orders Filtered","id":"c7323c69-7bc9-413b-8f1e-0478f4a36b79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}?fields=shippingInfo%2CorderId%2CorderStatus&sort=created_date&sortOrder=DESC&limit=5&filter=%7B%22orderStatus%22%3A%20%22printed%22%7D","description":"

Get a filtered dataset of your orders by using url params.

\n","urlObject":{"path":["{{version}}","orders","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[{"key":"fields","value":"shippingInfo%2CorderId%2CorderStatus"},{"key":"sort","value":"created_date"},{"key":"sortOrder","value":"DESC"},{"key":"limit","value":"5"},{"key":"filter","value":"%7B%22orderStatus%22%3A%20%22printed%22%7D"}],"variable":[]}},"response":[{"id":"0a40473f-ebcb-4393-b7dd-2c6b0f95f9eb","name":"Get Orders Filtered - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}?fields=shippingInfo%2CorderId%2CorderStatus&sort=created_date&sortOrder=DESC&limit=3&filter=%7B%22orderStatus%22%3A%20%22printed%22%7D","host":["{{baseUrl}}"],"path":["{{version}}","orders","vendor","{{vendorId}}"],"query":[{"key":"fields","value":"shippingInfo%2CorderId%2CorderStatus"},{"key":"sort","value":"created_date"},{"key":"sortOrder","value":"DESC"},{"key":"limit","value":"3"},{"key":"filter","value":"%7B%22orderStatus%22%3A%20%22printed%22%7D"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Successfully retrieved orders\",\n \"orders\": [\n {\n \"_id\": \"5f03046e84ecc9520290bd50\",\n \"orderStatus\": \"printed\",\n \"orderId\": \"2500001103640763629\",\n \"shippingInfo\": {\n \"name\": \"Janet A Manning\",\n \"street1\": \"35 HICKORY HILL RD\",\n \"street2\": null,\n \"city\": \"EASTCHESTER\",\n \"state\": \"NY\",\n \"phone\": \"9147797554\",\n \"postcode\": \"10709-1453\",\n \"country_code\": \"us\"\n }\n },\n {\n \"_id\": \"5f03205184ecc9520290bda7\",\n \"orderStatus\": \"printed\",\n \"orderId\": \"2500001101484630105\",\n \"shippingInfo\": {\n \"name\": \"Joel Iams\",\n \"street1\": \"1224 DALE DR\",\n \"street2\": null,\n \"city\": \"SILVER SPRING\",\n \"state\": \"MD\",\n \"phone\": \"3015649537\",\n \"postcode\": \"20910-1609\",\n \"country_code\": \"us\"\n }\n },\n {\n \"_id\": \"5f032e6584ecc9520290bdb7\",\n \"orderStatus\": \"printed\",\n \"orderId\": \"2500001103219386097\",\n \"shippingInfo\": {\n \"name\": \"Dana Walker\",\n \"street1\": \"7014 BUCHANAN RD\",\n \"street2\": null,\n \"city\": \"TEMPLE HILLS\",\n \"state\": \"MD\",\n \"phone\": \"3012045563\",\n \"postcode\": \"20748-5322\",\n \"country_code\": \"us\"\n }\n }\n ]\n}"}],"_postman_id":"c7323c69-7bc9-413b-8f1e-0478f4a36b79"},{"name":"Get Single Order","event":[{"listen":"test","script":{"id":"5194ed8f-c156-484b-a78f-6e4ee8dc398a","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});"],"type":"text/javascript"}}],"id":"caa4faab-f5b0-5d9d-fe54-d06f4b17a129","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"

Replace with your API token

\n"}],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/vendor/{{vendorId}}","urlObject":{"path":["{{version}}","orders","{{orderId}}","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"9677d32b-9e27-43ff-a290-6158056b14bd","name":"Get Order - Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YjdlODc1ZGFlYzg1NjNiYzg3YWQ3MmEiLCJyb2xlIjozLCJ1c2VybmFtZSI6InJlZGJ1YmJsZSIsImlhdCI6MTYwMDE4NzU1OH0.YIO4tJFkRQ8XotkqsG1AQ8c_ONt5KmyKl78NHFawgkY","description":"Replace with your API token"}],"body":{"mode":"raw","raw":""},"url":"{{baseUrl}}/{{version}}/orders/abc/vendor/{{vendorId}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"44"},{"key":"ETag","value":"W/\"2c-6WNp1rZ6Qam+sMhdQ2I2gAQ87oI\""},{"key":"Date","value":"Fri, 01 Feb 2019 18:53:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Order cannot be found\",\n \"errorCode\": \"NotFound\"\n}"},{"id":"bdc365a3-6d41-dbe7-67e7-d890cb0c3550","name":"Get Order - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","description":"Replace with your API token","warning":""}],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"access-control-allow-origin","key":"access-control-allow-origin","value":"*","description":""},{"name":"connection","key":"connection","value":"keep-alive","description":""},{"name":"content-length","key":"content-length","value":"10204","description":""},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":""},{"name":"date","key":"date","value":"Fri, 01 Feb 2019 18:03:47 GMT","description":""},{"name":"etag","key":"etag","value":"W/\"27dc-C5EJPTlWDgp3+/tAzUhwWjawy6M\"","description":""},{"name":"server","key":"server","value":"Cowboy","description":""},{"name":"via","key":"via","value":"1.1 vegur","description":""},{"name":"x-powered-by","key":"x-powered-by","value":"Express","description":""}],"cookie":[],"responseTime":"121","body":"{\n \"success\": true,\n \"message\": \"Successfully retrieved order\",\n \"order\": {\n \"orderStatus\": \"printed\",\n \"created_date\": \"2018-11-29T14:00:32.928Z\",\n \"items\": [\n {\n \"assets\": [\n {\n \"_id\": \"5bfff1005ed05f00049e939d\",\n \"description\": \"front\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSWIN-21687L-1.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSWIN-21687L-1.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e939c\",\n \"description\": \"back\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSWIN-21687L-2.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSWIN-21687L-2.png\"\n }\n ],\n \"itemId\": 113020180101,\n \"product\": \"one-piece-swimsuit\",\n \"properties\": {\n \"size\": \"LG\"\n },\n \"sku\": \"SW804_OC_LG\",\n \"description\": \"one-piece-swimsuit\",\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSWIN-21687L-1.png\",\n \"quantity\": 1,\n \"price\": 1.99,\n \"weight\": {\n \"value\": 1,\n \"units\": \"ounces\"\n }\n },\n {\n \"assets\": [\n {\n \"_id\": \"5bfff1005ed05f00049e9398\",\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XLN-4053L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XLN-4053L.png\"\n }\n ],\n \"itemId\": 113020180102,\n \"product\": \"legging-with-band\",\n \"properties\": {\n \"size\": \"LG\"\n },\n \"sku\": \"X101_OC_LG\",\n \"description\": \"legging-with-band\",\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XLN-4053L.png\",\n \"quantity\": 1,\n \"price\": 1.99,\n \"weight\": {\n \"value\": 1,\n \"units\": \"ounces\"\n }\n },\n {\n \"assets\": [\n {\n \"_id\": \"5bfff1005ed05f00049e9394\",\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19873L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19873L.png\"\n }\n ],\n \"itemId\": 113020180103,\n \"product\": \"capri-with-band\",\n \"properties\": {\n \"size\": \"LG\"\n },\n \"sku\": \"X102_OC_LG\",\n \"description\": \"capri-with-band\",\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/XCN-19873L.png\",\n \"quantity\": 1,\n \"price\": 1.99,\n \"weight\": {\n \"value\": 1,\n \"units\": \"ounces\"\n }\n },\n {\n \"assets\": [\n {\n \"_id\": \"5bfff1005ed05f00049e9390\",\n \"description\": \"artwork\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERLN-21465L.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERLN-21465L.png\"\n }\n ],\n \"itemId\": 113020180104,\n \"product\": \"legging\",\n \"properties\": {\n \"size\": \"LG\"\n },\n \"sku\": \"X103_OC_LG\",\n \"description\": \"legging\",\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERLN-21465L.png\",\n \"quantity\": 1,\n \"price\": 1.99,\n \"weight\": {\n \"value\": 7,\n \"units\": \"ounces\"\n }\n },\n {\n \"assets\": [\n {\n \"_id\": \"5bfff1005ed05f00049e938c\",\n \"description\": \"sleeve_right\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-1.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSMN-20662L-1.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e938b\",\n \"description\": \"front\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-2.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSMN-20662L-2.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e938a\",\n \"description\": \"sleeve_left\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-3.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSMN-20662L-3.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e9389\",\n \"description\": \"back\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-4.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSMN-20662L-4.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e9388\",\n \"description\": \"waist\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-5.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSMN-20662L-5.png\"\n }\n ],\n \"itemId\": 113020180105,\n \"product\": \"crewneck-sweatshirt\",\n \"properties\": {\n \"size\": \"LG\"\n },\n \"sku\": \"X203_OC_LG\",\n \"description\": \"crewneck-sweatshirt\",\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERSMN-20662L-1.png\",\n \"quantity\": 1,\n \"price\": 1.99,\n \"weight\": {\n \"value\": 1,\n \"units\": \"ounces\"\n }\n },\n {\n \"assets\": [\n {\n \"_id\": \"5bfff1005ed05f00049e9384\",\n \"description\": \"sleeve_right\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-1.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-1.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e9383\",\n \"description\": \"front\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-2.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-2.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e9382\",\n \"description\": \"sleeve_left\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-3.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-3.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e9381\",\n \"description\": \"back\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-4.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-4.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e9380\",\n \"description\": \"hood\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-5.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-5.png\"\n },\n {\n \"_id\": \"5bfff1005ed05f00049e937f\",\n \"description\": \"pocket\",\n \"url\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-6.png\",\n \"preview_url\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-6.png\"\n }\n ],\n \"itemId\": 113020180106,\n \"product\": \"pullover-hoodie\",\n \"properties\": {\n \"size\": \"LG\"\n },\n \"sku\": \"X201_OC_LG\",\n \"description\": \"pullover-hoodie\",\n \"previewImgUrl\": \"http://app.xyzclothing.com/vault/amazonthumbs/MERHN-20534L-2.png\",\n \"quantity\": 1,\n \"price\": 1.99,\n \"weight\": {\n \"value\": 1,\n \"units\": \"ounces\"\n }\n }\n ],\n \"artworksInOrder\": [\n {\n \"filename\": \"SW804_OC_LG_113020180101_1_FRONT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/SW804_OC_LG_113020180101_1_FRONT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSWIN-21687L-1.png\",\n \"itemSku\": \"SW804_OC_LG\",\n \"itemId\": 113020180101,\n \"description\": \"front\"\n },\n {\n \"filename\": \"SW804_OC_LG_113020180101_1_BACK.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/SW804_OC_LG_113020180101_1_BACK.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSWIN-21687L-2.png\",\n \"itemSku\": \"SW804_OC_LG\",\n \"itemId\": 113020180101,\n \"description\": \"back\"\n },\n {\n \"filename\": \"X101_OC_LG_113020180102_1_0.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X101_OC_LG_113020180102_1_0.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XLN-4053L.png\",\n \"itemSku\": \"X101_OC_LG\",\n \"itemId\": 113020180102,\n \"description\": \"artwork\"\n },\n {\n \"filename\": \"X102_OC_LG_113020180103_1_0.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X102_OC_LG_113020180103_1_0.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/XCN-19873L.png\",\n \"itemSku\": \"X102_OC_LG\",\n \"itemId\": 113020180103,\n \"description\": \"artwork\"\n },\n {\n \"filename\": \"X103_OC_LG_113020180104_1_0.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X103_OC_LG_113020180104_1_0.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERLN-21465L.png\",\n \"itemSku\": \"X103_OC_LG\",\n \"itemId\": 113020180104,\n \"description\": \"artwork\"\n },\n {\n \"filename\": \"X203_OC_LG_113020180105_1_SLEEVE_RIGHT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X203_OC_LG_113020180105_1_SLEEVE_RIGHT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-1.png\",\n \"itemSku\": \"X203_OC_LG\",\n \"itemId\": 113020180105,\n \"description\": \"sleeve_right\"\n },\n {\n \"filename\": \"X203_OC_LG_113020180105_1_FRONT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X203_OC_LG_113020180105_1_FRONT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-2.png\",\n \"itemSku\": \"X203_OC_LG\",\n \"itemId\": 113020180105,\n \"description\": \"front\"\n },\n {\n \"filename\": \"X203_OC_LG_113020180105_1_SLEEVE_LEFT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X203_OC_LG_113020180105_1_SLEEVE_LEFT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-3.png\",\n \"itemSku\": \"X203_OC_LG\",\n \"itemId\": 113020180105,\n \"description\": \"sleeve_left\"\n },\n {\n \"filename\": \"X203_OC_LG_113020180105_1_BACK.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X203_OC_LG_113020180105_1_BACK.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-4.png\",\n \"itemSku\": \"X203_OC_LG\",\n \"itemId\": 113020180105,\n \"description\": \"back\"\n },\n {\n \"filename\": \"X203_OC_LG_113020180105_1_WAIST.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X203_OC_LG_113020180105_1_WAIST.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERSMN-20662L-5.png\",\n \"itemSku\": \"X203_OC_LG\",\n \"itemId\": 113020180105,\n \"description\": \"waist\"\n },\n {\n \"filename\": \"X201_OC_LG_113020180106_1_SLEEVE_RIGHT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X201_OC_LG_113020180106_1_SLEEVE_RIGHT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-1.png\",\n \"itemSku\": \"X201_OC_LG\",\n \"itemId\": 113020180106,\n \"description\": \"sleeve_right\"\n },\n {\n \"filename\": \"X201_OC_LG_113020180106_1_FRONT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X201_OC_LG_113020180106_1_FRONT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-2.png\",\n \"itemSku\": \"X201_OC_LG\",\n \"itemId\": 113020180106,\n \"description\": \"front\"\n },\n {\n \"filename\": \"X201_OC_LG_113020180106_1_SLEEVE_LEFT.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X201_OC_LG_113020180106_1_SLEEVE_LEFT.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-3.png\",\n \"itemSku\": \"X201_OC_LG\",\n \"itemId\": 113020180106,\n \"description\": \"sleeve_left\"\n },\n {\n \"filename\": \"X201_OC_LG_113020180106_1_BACK.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X201_OC_LG_113020180106_1_BACK.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-4.png\",\n \"itemSku\": \"X201_OC_LG\",\n \"itemId\": 113020180106,\n \"description\": \"back\"\n },\n {\n \"filename\": \"X201_OC_LG_113020180106_1_HOOD.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X201_OC_LG_113020180106_1_HOOD.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-5.png\",\n \"itemSku\": \"X201_OC_LG\",\n \"itemId\": 113020180106,\n \"description\": \"hood\"\n },\n {\n \"filename\": \"X201_OC_LG_113020180106_1_POCKET.png\",\n \"filePathName\": \"xyzclothing/2018/11/29/1130201801/X201_OC_LG_113020180106_1_POCKET.png\",\n \"originUrl\": \"https://s3-us-west-2.amazonaws.com/xyzclothing/MERHN-20534L-6.png\",\n \"itemSku\": \"X201_OC_LG\",\n \"itemId\": 113020180106,\n \"description\": \"pocket\"\n }\n ],\n \"orderId\": 1130201801,\n \"sale_datetime\": \"2019-11-01T23:28:56.782Z\",\n \"companyRefId\": \"xyzclothing\",\n \"callbackUri\": \"https://app.xyzclothing.com/v4/views/f4_orderstatus.php?auth=ngzlawgnveqfJFE2813tuihwdnf3atcsdgsh23\",\n \"shippingInfo\": {\n \"name\": \"Test Dummy\",\n \"street1\": \"940 Shadow Mountain Drive\",\n \"city\": \"Susanville\",\n \"state\": \"CA\",\n \"postcode\": \"96130\",\n \"country_code\": \"US\"\n },\n \"customerName\": \"Test Dummy\",\n \"shippingMethod\": \"standard\",\n \"shipStationId\": 12600683,\n \"createdAt\": \"2018-11-29T14:00:32.942Z\",\n \"updatedAt\": \"2018-11-29T23:57:22.492Z\"\n }\n}"}],"_postman_id":"caa4faab-f5b0-5d9d-fe54-d06f4b17a129"},{"name":"Get Order Status","id":"7acab505-b77e-55ff-b8a6-87115e7621bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/status/vendor/{{vendorId}}","description":"

Retrieve the status of an order by using the orders reference id (\"orderKey\")

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Status	Description
orderId	All*	The order's ID
status	All*	The order's production status
message	All*	A custom description
shipmentId	shipped	The ShipStation's orderId
trackingNumber	shipped	The shipment's tracking number
ship_date	shipped	The shipment's date in UTC
carrier	shipped	The shipment's carrier code
service	shipped	The shipment's service code
reason	cancelled, voided	The cancellation reason
date_cancelled	cancelled, voided	The date the order was cancelled in UTC

*Available for all production statuses

\n","urlObject":{"path":["{{version}}","orders","{{orderId}}","status","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0d26f254-7523-4f44-a604-51b427958673","name":"Get Order Status - Cancelled","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/status/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"155"},{"key":"ETag","value":"W/\"9b-R3GV01ucTkN2w+gA+Y5X82luL7A\""},{"key":"Date","value":"Tue, 15 Sep 2020 19:33:45 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": 2091185864793,\n \"status\": \"cancelled\",\n \"message\": \"This order has been cancelled\",\n \"reason\": \"Vendor Requested\",\n \"date_cancelled\": \"2020-09-15T19:30:02.954Z\"\n}"},{"id":"8145febe-fdbc-4bcd-a63d-524b0f296b37","name":"Get Order Status - Printed","originalRequest":{"method":"GET","header":[{"description":"Replace with your API token","key":"Authorization","value":"Bearer {{token}}"}],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/status/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"120"},{"key":"Etag","value":"W/\"78-m+rSMYHrns6uKzNKL+kDmEx+kFk\""},{"key":"Date","value":"Fri, 01 Feb 2019 18:22:43 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"orderId\": 2091185864793,\n \"status\": \"printed\",\n \"message\": \"The order has been successfully printed and moved on to next stage\"\n}"},{"id":"958909c7-81c5-4508-b230-542feba01678","name":"Get Order Status - Shipped","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/status/vendor/{{vendorId}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"orderId\": 2091185864793,\r\n \"status\": \"shipped\",\r\n \"message\": \"The order has been successfully shipped on our end\",\r\n \"shipmentId\": 521521525,\r\n \"trackingNumber\": \"92748902477271543400009602\",\r\n \"ship_date\": \"2020-05-06T16:45:05.900Z\",\r\n \"carrier\": \"fedex\",\r\n \"service\": \"fedex_international_priority\"\r\n}"}],"_postman_id":"7acab505-b77e-55ff-b8a6-87115e7621bc"},{"name":"Get Order Activity","id":"3901fe80-f410-4fb4-aa04-9b92774bcaf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/activity/vendor/{{vendorId}}","description":"

Retrieves an order's latest activity log.

\n","urlObject":{"path":["{{version}}","orders","{{orderId}}","activity","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"74b3f222-6822-4f5e-a21a-a36d93faf2e7","name":"Get Order Activity - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{baseUrl}}/{{version}}/orders/{{orderId}}/activity/vendor/{{vendorId}}"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"status\": \"cancelled\",\n \"activity\": [\n {\n \"affectedItems\": [],\n \"title\": \"Cancelled order\",\n \"action\": \"CANCEL_ORDER\",\n \"description\": \"Note: Vendor Requested\",\n \"datetime\": \"2020-09-16T16:36:26.287Z\"\n },\n {\n \"affectedItems\": [],\n \"title\": \"Printed order\",\n \"action\": \"PRINT_ORDER\",\n \"datetime\": \"2020-09-16T16:36:15.587Z\"\n },\n {\n \"affectedItems\": [],\n \"title\": \"Artwork status update\",\n \"action\": \"UPDATE_ARTWORK_STATUS\",\n \"description\": \"Artwork status updated to: queued\",\n \"datetime\": \"2020-09-04T09:08:49.290Z\",\n \"by\": \"STYLUSOP\"\n },\n {\n \"affectedItems\": [],\n \"title\": \"Artwork status update\",\n \"action\": \"UPDATE_ARTWORK_STATUS\",\n \"description\": \"Artwork status updated to: queued\",\n \"datetime\": \"2020-09-04T09:06:08.241Z\",\n \"by\": \"STYLUSOP\"\n },\n {\n \"affectedItems\": [],\n \"title\": \"Artwork status update\",\n \"action\": \"UPDATE_ARTWORK_STATUS\",\n \"description\": \"Artwork status updated to: queued\",\n \"datetime\": \"2020-09-04T09:01:16.080Z\",\n \"by\": \"STYLUSOP\"\n },\n {\n \"affectedItems\": [],\n \"title\": \"Artwork status update\",\n \"action\": \"UPDATE_ARTWORK_STATUS\",\n \"description\": \"Artwork status updated to: queued\",\n \"datetime\": \"2020-09-04T09:01:15.768Z\",\n \"by\": \"STYLUSOP\"\n },\n {\n \"affectedItems\": [],\n \"title\": \"Created order\",\n \"action\": \"CREATE_ORDER\",\n \"datetime\": \"2020-09-02T18:22:55.473Z\"\n }\n ]\n}"}],"_postman_id":"3901fe80-f410-4fb4-aa04-9b92774bcaf2"},{"name":"Update Order","id":"3d581a33-7ade-4121-929f-9383cd8f43b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YjMzNTNmZWQ0MjIzNDEzMTBhYzZlN2YiLCJyb2xlIjoxLCJpYXQiOjE1MzcxOTIxODMsImV4cCI6MTUzOTc4NDE4M30.3u6V7mA3ZXTQ_J9IswM40vyaLuT_JpnqELGHfCBC8h0"}],"body":{"mode":"raw","raw":"{\n\t\"orderKey\": \"5e7105462a92c02bc0b11f79\",\n \"priorityLabel\": \"vip\",\n \"shippingInfo\": {\n \"name\": \"your updated name\",\n \"street1\": \"your updated street1\",\n \"city\": \"your updated city\"\n },\n \"returnToAddress\": {\n \"company\": \"your updated company name\",\n \"street1\": \"your updated street1\",\n \"city\": \"your updated city\"\n },\n\t\"items\": [\n\t\t{\n\t\t\t\"assets\": [\n\t\t\t\t{\n\t\t\t\t\t\"description\": \"artwork\",\n\t\t\t\t\t\"url\": \"https://s3.amazonaws.com/merch-it--xlusion/MERLN-21463S.png\",\n\t\t\t\t\t\"preview_url\": \"https://app.merch-it.com/vault/amazonthumbs/MERLN-21463S.png\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"itemId\": 2477539164242,\n\t\t\t\"product\": \"leggings\",\n\t\t\t\"properties\": {\n\t\t\t\t\"size\": \"SM\",\n\t\t\t\t\"color\": \"OC\"\n\t\t\t},\n\t\t\t\"sku\": \"X103_OC_SM\",\n\t\t\t\"description\": \"MERLN-21463S\",\n\t\t\t\"previewImgUrl\": \"https://app.merch-it.com/vault/amazonthumbs/MERLN-21463S.png\",\n\t\t\t\"quantity\": 2,\n\t\t\t\"price\": 1.99,\n\t\t\t\"weight\": {\n\t\t\t\t\"value\": 7,\n\t\t\t\t\"units\": \"ounces\"\n\t\t\t}\n\t\t}\n\t]\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}","urlObject":{"path":["{{version}}","orders","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ce5f7067-7644-40f4-a3f9-d422a2da4a35","name":"Update Order","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1YjMzNTNmZWQ0MjIzNDEzMTBhYzZlN2YiLCJyb2xlIjoxLCJpYXQiOjE1MzcxOTIxODMsImV4cCI6MTUzOTc4NDE4M30.3u6V7mA3ZXTQ_J9IswM40vyaLuT_JpnqELGHfCBC8h0"}],"body":{"mode":"raw","raw":"{\n\t\"orderKey\": \"5e7105462a92c02bc0b11f79\",\n \"priorityLabel\": \"vip\",\n \"shippingInfo\": {\n \"name\": \"your updated name\",\n \"street1\": \"your updated street1\",\n \"city\": \"your updated city\"\n },\n \"returnToAddress\": {\n \"company\": \"your updated company name\",\n \"street1\": \"your updated street1\",\n \"city\": \"your updated city\"\n },\n\t\"items\": [\n\t\t{\n\t\t\t\"assets\": [\n\t\t\t\t{\n\t\t\t\t\t\"description\": \"artwork\",\n\t\t\t\t\t\"url\": \"https://s3.amazonaws.com/merch-it--xlusion/MERLN-21463S.png\",\n\t\t\t\t\t\"preview_url\": \"https://app.merch-it.com/vault/amazonthumbs/MERLN-21463S.png\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"itemId\": 2477539164242,\n\t\t\t\"product\": \"leggings\",\n\t\t\t\"properties\": {\n\t\t\t\t\"size\": \"SM\",\n\t\t\t\t\"color\": \"OC\"\n\t\t\t},\n\t\t\t\"sku\": \"X103_OC_SM\",\n\t\t\t\"description\": \"MERLN-21463S\",\n\t\t\t\"previewImgUrl\": \"https://app.merch-it.com/vault/amazonthumbs/MERLN-21463S.png\",\n\t\t\t\"quantity\": 2,\n\t\t\t\"price\": 1.99,\n\t\t\t\"weight\": {\n\t\t\t\t\"value\": 7,\n\t\t\t\t\"units\": \"ounces\"\n\t\t\t}\n\t\t}\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"success\": true,\n\t\"message\": \"The order has been patched\",\n\t\"reference_id\": \"5e7105462a92c02bc0b11f79\"\n}"}],"_postman_id":"3d581a33-7ade-4121-929f-9383cd8f43b8"},{"name":"Update Order Artwork broken links","id":"8c03abb0-a22b-9445-8055-04b723d12a63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"username":"","password":"","saveHelperData":"","showPassword":""},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YXBpdXNlcjphcGl1c2VyMTIzIQ=="}],"body":{"mode":"raw","raw":"{\n\t\"orderKey\": \"5e7105462a92c02bc0b11f79\",\n\t\"items\": [\n \t{\n \t\t\"itemNumber\": 380625286,\n \t\t\"price\": 32,\n \t\t\"assets\": [\n \t\t{\n \t\t\t \"url\": \"https://asset-wala-k8s-staging.s3.amazonaws.com/fulfillment/standard/7202001_scarf_620ba9d8ead053f5ef89af839cdcb0b7.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIQBTFMWCLJQP7AZQ%2F20180726%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180726T223717Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=affecd856e92542601b2a25424d6f69d6a5044ad5c98f8c40e9d8618b5be8f17\"\n \t\t}\n\t\t\t],\n \t\t\"product\": \"scarf\"\n\t\t}\n\t]\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}","urlObject":{"path":["{{version}}","orders","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ae53a067-377a-430e-a5ec-14eb2624a333","name":"Update Order Artwork broken links","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic YXBpdXNlcjphcGl1c2VyMTIzIQ=="}],"body":{"mode":"raw","raw":"{\n\t\"orderKey\": \"5e7105462a92c02bc0b11f79\",\n\t\"items\": [\n \t{\n \t\t\"itemNumber\": 380625286,\n \t\t\"price\": 32,\n \t\t\"assets\": [\n \t\t{\n \t\t\t \"url\": \"https://asset-wala-k8s-staging.s3.amazonaws.com/fulfillment/standard/7202001_scarf_620ba9d8ead053f5ef89af839cdcb0b7.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIQBTFMWCLJQP7AZQ%2F20180726%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20180726T223717Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=affecd856e92542601b2a25424d6f69d6a5044ad5c98f8c40e9d8618b5be8f17\"\n \t\t}\n\t\t\t],\n \t\t\"product\": \"scarf\"\n\t\t}\n\t]\n}"},"url":"{{baseUrl}}/{{version}}/orders/vendor/{{vendorId}}"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"reference_id\": \"5e7105462a92c02bc0b11f79\"\t\n}"}],"_postman_id":"8c03abb0-a22b-9445-8055-04b723d12a63"}],"id":"78937c83-a4b4-4921-e349-78a938ddde76","description":"

Orders API

Most operations that our API support deal with orders. Most likely, you will want to either POST, GET, or PATCH an order. We will cover all those cases

\n $\"alt$ \n\n

Pushing / Creating an order

To push or create an order you will want to send a POST request to the following endpoint

POST /api/v2/orders/vendor/{vendorId}\n\n

Please check the body of the sample request for you to know how to structure your payload

Fetching order(s)

To get your orders you would want to send a GET request to the following endpoint:

GET /api/v2/orders/vendor/{vendorId}                (Fetch all open orders)\nGET /api/v2/orders/{orderId}/vendor/{vendorId}      (Fetch one open order by its ID) \n\n

Filtering using URL params

You can use URL params added to the fetch endpoint to filter out results for faster queries. Also, you can use pagination by using the \"offset\" and \"limit\" query fields.

GET /api/v2/orders/vendor/{vendorId}/\n     ?fields=shippingInfo,orderId,orderStatus\n     &sort=created_date\n     &sortOrder=ASC\n     &limit=5\n     &filter={\"orderStatus\":\"printed\"}    \n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Url Param	Description
\"fields\"	Specify the order fields that you would like to be included in the response. All other fields will be excluded.
\"sort\"	Specify the field that will be use for sorting the results
\"sortOrder\"	Specify the sort order. Used in combination with \"sort\". Possible values are: DESC, ASC
\"offset\"	Used for pagination. Skips the orders results by its value
\"limit\"	Used for pagination. Limits the number of order records by its value
\"filter\"	Stringified JSON object (key:value) for to further filter your result dataset using the order's field and value

Updating / Patching order

An order can be updated through the API with limitations. Often times the vendor will want to update the shipping address, customer details, shipment details and even the line-items.
To perform an \"update\" you need to send a PATCH request to the orders endpoint as follows:

PATCH /api/v2/orders/vendor/{vendor}\n\n

For the body of the request, you MUST include the \"orderKey\" field along with the other fields you want to update.

 {\n    \"orderKey\": \"5e7105462a92c02bc0b11f79\",\n    \"priorityLabel\": \"vip\",\n    \"shippingMethod\": \"express\",\n    \"shippingInfo\": {\n      \"name\": \"your updated name\",\n      \"street1\": \"your updated street1\",\n      \"city\": \"your updated city\"\n    },\n    \"returnToAddress\": {\n      \"company\": \"your updated company name\",\n      \"street1\": \"your updated street1\",\n      \"city\": \"your updated city\"\n    },\n    \"items\": [\n        ...\n    ],\n    ...\n }\n\n

\n
Important Notes:
\n

Response Statuses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Type	Description
204	SuccessNoContent	Success. The order has been updated
400	BadRequest	Error. The request body contains malformatted data or includes \"read-only\" fields
422	UnprocessableEntity	Error. The request body contains malformatted data or includes \"read-only\" fields
500	InternalError	Error. Something unexpected happened

Cancelling order / line-items

The vendor is able to cancel an order or specific line-items in an order by sending a POST request as shown:

POST /api/v2/orders/{orderId}/cancel/vendor/{vendorId}\n\n

To cancel line-items of an order rather than the entire order, you may define an array of line-item's ids in the request body as follows:

{\n  \"items\": [234142142, 263165313],\n  \"reason\": \"Your cancellation note here...\"\n}\n\n

To cancel the entire order, simply don't include an \"items\" key in the json payload.

\n
Important Note: An order can only be cancelled through our API up to a certain point during its production life-cycle and get a full refund.
*Once passed the \"printed\" status, a full refund is not possible. *
\n

The \"Callback Uri\"

If you plan on receiving Status Update Notifications, a callback uri should be included inside your POST request body.

A callback uri is a pre-authorized HTTP url endpoint that you expose and its capable of processing POST requests. This endpoint should be public, meaning that we should not have to include authorization headers in the request. In order to do that, you want to include a pre-authorized token in the params of the callback url.

For example:

   https://www.xyzclothing.com/api/fulfiller/stylus_usa/purchase_order/117843/status_update?token=b5247e7b298464bdcc4472727e95c01ff\n\n

If you are planning on adding expiration to your *callback uri*, you might want to ensure that the provided *callback uri* is available for at least 14 days to prevent any errors from occurring while sending you the status update notifications.

Status Update Notifications (SUNs) - Webhooks

A Status Update Notification or SUN is a POST request we send over to your callback uri in order to update you of the status of an order when it has changed.

There are different Status Update Notifications that we send to your order's callback uri as it moves long its production pipeline:

\"Picked\" - Order has been picked for printing
\"Printed\" - Order has been printed
\"Shipped\" - Order has been shipped

In certain cases however, we might also send the following statuses:

\"Error\" - Possible reasons could be Corrupt artwork, invalid address, unreachable artwork url, etc..
\"Cancelled\", \"Voided\" - Entire order or line-item has been cancelled.
\"Delayed\" - ***Order's production has been delayed. ***

The \"body\" of the the HTTP request varies depending on the status itself.

For instance, a status update notification for \"printed\" looks like this:

{\n  \"order_id\": 40352,\n  \"status\": \"printed\",\n  \"items\": [\n    { \"item_id\": 403520 },\n    { \"item_id\": 403521 },\n    { \"item_id\": 403522 }\n  ],\n  \"location\": \"New Jersey/USA\"\n}\n\n

However, a Status Update Notification for the \"shipped\" event contains extra data in it:

{\n  \"order_id\": 40352,\n  \"status\": \"shipped\",\n  \"items\": [\n      { \"item_id\": 403520 },\n      { \"item_id\": 403521 },\n      { \"item_id\": 403522 }\n  ],\n  \"location\": \"New Jersey/USA\",\n  \"tracking\": 782032965647,\n  \"service\": \"mail_innovations\",\n  \"carrier\": \"ups\"\n}\n\n

There are fields that are common to all SUNs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`order_id`	string	The unique orderId
`status`	string	The new status of the order or the specified items
`items`	array	An array of objects that contains the \"item_id\" or line item unique identifier inside the order. If specified, the status notification applies only to these items. If not, then the status applies to all the order's line-items
`location`	string	A string describing the physical location from which this event has originated from.

Extra fields depending on the \"status\" of the order:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`tracking`	string	Only when status is \"shipped\". The tracking number of the latest shipment
`service`	string	Only when status is \"shipped\". The shipment service code
`carrier`	string	Only when status is \"shipped\". The shipment carrier code
`message`	string	A custom message. This might be empty
`type`	string	Only when status is \"error\". The type of error for the order. Possible values: \"artwork\", \"address\", \"print\"
`hours`	string	Only when status is \"delayed\". The amount of hours this order is or will be delayed.

","event":[{"listen":"prerequest","script":{"id":"fb1af8ab-50cd-4a9b-8273-8d72c43eb63a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8d0e14a3-8b09-4925-a186-556ea90b734b","type":"text/javascript","exec":[""]}}],"_postman_id":"78937c83-a4b4-4921-e349-78a938ddde76"},{"name":"Products API","item":[{"name":"Get Products","id":"01b836ca-f848-43b5-aeb5-f43728749647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/products/vendor/{{vendorId}}","description":"

Retrieves all available products

\n","urlObject":{"path":["{{version}}","products","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"aa0e8163-7165-4932-95cd-4a5c59eaf0c9","name":"Get Products - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{baseUrl}}/{{version}}/products/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Via","value":"1.1 tinyproxy (tinyproxy/1.8.4)"},{"key":"Content-Length","value":"69"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"45-FV4yY9c99nIU9dqvxOmPDmuwswc\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Powered-By","value":"Express"},{"key":"Date","value":"Wed, 16 Sep 2020 16:08:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"availableSizes\": [\n \"XS\",\n \"SM\",\n \"MD\",\n \"LG\",\n \"XL\",\n \"2XL\",\n \"3XL\",\n \"4XL\",\n \"5XL\"\n ],\n \"availableColors\": [\n \"Aqua\",\n \"Army\",\n \"Ash\",\n \"Asphalt\",\n \"Autumn\",\n \"Baby Blue\",\n \"Berry\",\n \"Black\",\n \"Brown\",\n \"Burnt Orange\",\n \"Canvas Red\",\n \"Cardinal\",\n \"Charity Pink\",\n \"Columbia Blue\",\n \"Coral\",\n \"Dark Grey\",\n \"Dark Olive\",\n \"Deep Teal\",\n \"Evergreen\",\n \"Forest\",\n \"Fuchsia\",\n \"Gold\",\n \"Kelly\",\n \"Leaf\",\n \"Light Blue\",\n \"Lilac\",\n \"Maize Yellow\",\n \"Maroon\",\n \"Mauve\",\n \"Military Green\",\n \"Mint\",\n \"Mustard\",\n \"Natural\",\n \"Navy\",\n \"Ocean Blue\",\n \"Olive\",\n \"Orange\",\n \"Oxblood Black\",\n \"Pebble Brown\",\n \"Pink\",\n \"Poppy\",\n \"Red\",\n \"Rust\",\n \"Sand Dune\",\n \"Silver\",\n \"Soft Cream\",\n \"Soft Pink\",\n \"Steel Blue\",\n \"Storm\",\n \"Sunset\",\n \"Tan\",\n \"Teal\",\n \"Team Navy\",\n \"Team Purple\",\n \"True Royal\",\n \"Turquoise\",\n \"Vintage Black\",\n \"Vintage White\",\n \"White\",\n \"Yellow\"\n ],\n \"templates\": [],\n \"sides\": [\n \"front\",\n \"back\",\n \"left_sleeve\",\n \"right_sleeve\"\n ],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a7e\",\n \"skuCode\": \"3001\",\n \"title\": \"Unisex Jersey T-Shirt\",\n \"productId\": \"3001ea6d\",\n \"name\": \"unisex-jersey-t-shirt\",\n \"brand\": \"Bella+Canvas\",\n \"createdAt\": \"2020-06-02T21:20:17.566Z\",\n \"updatedAt\": \"2020-08-12T18:09:44.610Z\",\n \"weight\": {\n \"units\": \"oz\",\n \"value\": 7\n },\n \"artworkFileSettings\": {\n \"dpi\": 150\n }\n },\n {\n \"availableSizes\": [\n \"OS\"\n ],\n \"availableColors\": [\n \"Black\",\n \"Natural/Black\",\n \"Natural/Navy\",\n \"Natural\",\n \"Natural/Hunter\",\n \"Natural/Red\",\n \"Navy\",\n \"Sterling Grey\",\n \"Red\"\n ],\n \"templates\": [],\n \"sides\": [],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a83\",\n \"skuCode\": \"B150\",\n \"title\": \"Budget Tote Bag\",\n \"productId\": \"B1500bae\",\n \"name\": \"budget-tote-bag\",\n \"brand\": \"Stylus Apparel\",\n \"createdAt\": \"2020-06-02T21:20:17.568Z\",\n \"updatedAt\": \"2020-06-02T21:20:17.568Z\"\n },\n {\n \"availableSizes\": [\n \"SM\",\n \"MD\",\n \"LG\",\n \"XL\",\n \"2XL\"\n ],\n \"availableColors\": [\n \"Aqua\",\n \"Army\",\n \"Ash\",\n \"Asphalt\",\n \"Athletic Heather\",\n \"Baby Blue\",\n \"Berry\",\n \"Black\",\n \"Brown\",\n \"Cardinal\",\n \"Coral\",\n \"Dark Grey\",\n \"Deep Teal\",\n \"Gold\",\n \"Kelly\",\n \"Leaf\",\n \"Lilac\",\n \"Maroon\",\n \"Mauve\",\n \"Military Green\",\n \"Navy\",\n \"Ocean Blue\",\n \"Olive\",\n \"Orange\",\n \"Pebble Brown\",\n \"Pink\",\n \"Red\",\n \"Seafoam Blue\",\n \"Silver\",\n \"Soft Cream\",\n \"Solid Black Blend\",\n \"Solid White Blend\",\n \"Steel Blue\",\n \"Storm\",\n \"Tan\",\n \"Teal\",\n \"Team Purple\",\n \"True Royal\",\n \"Turquoise\",\n \"White\",\n \"Yellow\"\n ],\n \"templates\": [],\n \"sides\": [\n \"front\",\n \"back\",\n \"left_sleeve\",\n \"right_sleeve\"\n ],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a7f\",\n \"skuCode\": \"6004\",\n \"title\": \"Ladies' The Favorite T-Shirt\",\n \"productId\": \"60047290\",\n \"name\": \"ladies-the-favorite-t-shirt\",\n \"brand\": \"Bella+Canvas\",\n \"createdAt\": \"2020-06-02T21:20:17.567Z\",\n \"updatedAt\": \"2020-08-12T18:12:22.353Z\",\n \"artworkFileSettings\": {\n \"dpi\": 150\n },\n \"weight\": {\n \"units\": \"oz\",\n \"value\": 2\n }\n },\n {\n \"availableSizes\": [\n \"SM\",\n \"MD\",\n \"LG\",\n \"XL\",\n \"2XL\",\n \"3XL\"\n ],\n \"availableColors\": [\n \"Army Heather\",\n \"Black\",\n \"Charcoal Heather\",\n \"Classic Navy\",\n \"Classic Navy Heather\",\n \"Forest Camo\",\n \"Grey Heather\",\n \"Gunmetal Heather\",\n \"Royal Heather\",\n \"White\"\n ],\n \"templates\": [],\n \"sides\": [],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a81\",\n \"skuCode\": \"SS3000\",\n \"title\": \"Midweight Crewneck Sweatshirt\",\n \"productId\": \"SS3000c0e9\",\n \"name\": \"midweight-crewneck-sweatshirt\",\n \"brand\": \"Independent Trading Co.\",\n \"createdAt\": \"2020-06-02T21:20:17.567Z\",\n \"updatedAt\": \"2020-06-02T21:20:17.567Z\"\n },\n {\n \"availableSizes\": [\n \"SM\",\n \"MD\",\n \"LG\",\n \"XL\",\n \"2XL\",\n \"3XL\",\n \"XS\"\n ],\n \"availableColors\": [\n \"Alpine Green\",\n \"Army\",\n \"Army Heather\",\n \"Black\",\n \"Black Camo\",\n \"Charcoal\",\n \"Charcoal Heather\",\n \"Classic Navy\",\n \"Classic Navy Heather\",\n \"Forest Camo\",\n \"Gold\",\n \"Grey Heather\",\n \"Gunmetal Heather\",\n \"Heather Blue\",\n \"Kelly Green Heather\",\n \"Lavender\",\n \"Light Pink\",\n \"Light Yellow\",\n \"Maroon\",\n \"Mint\",\n \"Neon Pink\",\n \"Peach\",\n \"Red\",\n \"Royal\",\n \"Safety Orange\",\n \"Safety Yellow\",\n \"Sandstone\",\n \"White\"\n ],\n \"templates\": [],\n \"sides\": [\n \"front\",\n \"back\",\n \"left_sleeve\",\n \"right_sleeve\"\n ],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a80\",\n \"skuCode\": \"SS4500\",\n \"title\": \"Midweight Hooded Sweatshirt\",\n \"productId\": \"SS4500779e\",\n \"name\": \"midweight-hooded-sweatshirt\",\n \"brand\": \"Independent Trading Co.\",\n \"createdAt\": \"2020-06-02T21:20:17.567Z\",\n \"updatedAt\": \"2020-08-12T18:13:20.260Z\",\n \"artworkFileSettings\": {\n \"dpi\": 150\n },\n \"weight\": {\n \"units\": \"oz\",\n \"value\": 4\n }\n },\n {\n \"availableSizes\": [\n \"nb\",\n \"6mos\",\n \"12mos\",\n \"18mos\",\n \"24mos\"\n ],\n \"availableColors\": [\n \"Apple\",\n \"Ballerina\",\n \"Black\",\n \"Butter\",\n \"Caribbean\",\n \"Carolina Blue\",\n \"Charcoal\",\n \"Chill\",\n \"Cobalt\",\n \"Forest\",\n \"Garnet\",\n \"Gold\",\n \"Granite Heather\",\n \"Heather\",\n \"Hot Pink\",\n \"Kelly\",\n \"Key Lime\",\n \"Lavender\",\n \"Light Blue\",\n \"Mauvelous\",\n \"Military Green\",\n \"Natural Heather\",\n \"Navy\",\n \"Orange\",\n \"Papaya\",\n \"Pink\",\n \"Purple\",\n \"Raspberry\",\n \"Red\",\n \"Royal\",\n \"Turquoise\",\n \"Vintage Burgundy\",\n \"Vintage Camo\",\n \"Vintage Green\",\n \"Vintage Hot Pink\",\n \"Vintage Navy\",\n \"Vintage Orange\",\n \"Vintage Purple\",\n \"Vintage Red\",\n \"Vintage Royal\",\n \"Vintage Smoke\",\n \"Vintage Turquois\",\n \"White\",\n \"Yellow\"\n ],\n \"templates\": [],\n \"sides\": [],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a82\",\n \"skuCode\": \"4424\",\n \"title\": \"Infant Fine Jersey Bodysuit\",\n \"productId\": \"44248243\",\n \"name\": \"infant-fine-jersey-bodysuit\",\n \"brand\": \"Rabbit Skins\",\n \"createdAt\": \"2020-06-02T21:20:17.568Z\",\n \"updatedAt\": \"2020-06-02T21:20:17.568Z\"\n }\n ]\n}"}],"_postman_id":"01b836ca-f848-43b5-aeb5-f43728749647"},{"name":"Get Single Product","id":"eb5a53c9-3cc1-4ed8-9312-d9ac6be32775","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/products/:productId/vendor/{{vendorId}}","description":"

Retrieves a single product by using its \"productId\"

\n","urlObject":{"path":["{{version}}","products",":productId","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"e2b9ac66-ef6d-464d-b849-a91e7a47456a","type":"any","value":"","key":"productId"}]}},"response":[{"id":"2594f555-f65b-4e2a-8ff4-b9570ff9ebd5","name":"Get Single Product - Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{baseUrl}}/{{version}}/products/3001ea6d/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Via","value":"1.1 tinyproxy (tinyproxy/1.8.4)"},{"key":"Content-Length","value":"69"},{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"ETag","value":"W/\"45-FV4yY9c99nIU9dqvxOmPDmuwswc\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Powered-By","value":"Express"},{"key":"Date","value":"Wed, 16 Sep 2020 16:08:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"availableSizes\": [\n \"XS\",\n \"SM\",\n \"MD\",\n \"LG\",\n \"XL\",\n \"2XL\",\n \"3XL\",\n \"4XL\",\n \"5XL\"\n ],\n \"availableColors\": [\n \"Aqua\",\n \"Army\",\n \"Ash\",\n \"Asphalt\",\n \"Autumn\",\n \"Baby Blue\",\n \"Berry\",\n \"Black\",\n \"Brown\",\n \"Burnt Orange\",\n \"Canvas Red\",\n \"Cardinal\",\n \"Charity Pink\",\n \"Columbia Blue\",\n \"Coral\",\n \"Dark Grey\",\n \"Dark Olive\",\n \"Deep Teal\",\n \"Evergreen\",\n \"Forest\",\n \"Fuchsia\",\n \"Gold\",\n \"Kelly\",\n \"Leaf\",\n \"Light Blue\",\n \"Lilac\",\n \"Maize Yellow\",\n \"Maroon\",\n \"Mauve\",\n \"Military Green\",\n \"Mint\",\n \"Mustard\",\n \"Natural\",\n \"Navy\",\n \"Ocean Blue\",\n \"Olive\",\n \"Orange\",\n \"Oxblood Black\",\n \"Pebble Brown\",\n \"Pink\",\n \"Poppy\",\n \"Red\",\n \"Rust\",\n \"Sand Dune\",\n \"Silver\",\n \"Soft Cream\",\n \"Soft Pink\",\n \"Steel Blue\",\n \"Storm\",\n \"Sunset\",\n \"Tan\",\n \"Teal\",\n \"Team Navy\",\n \"Team Purple\",\n \"True Royal\",\n \"Turquoise\",\n \"Vintage Black\",\n \"Vintage White\",\n \"White\",\n \"Yellow\"\n ],\n \"templates\": [],\n \"sides\": [\n \"front\",\n \"back\",\n \"left_sleeve\",\n \"right_sleeve\"\n ],\n \"enabled\": true,\n \"print_areas\": [],\n \"tags\": [],\n \"_id\": \"5ed6c29198ab2d2e11522a7e\",\n \"skuCode\": \"3001\",\n \"title\": \"Unisex Jersey T-Shirt\",\n \"productId\": \"3001ea6d\",\n \"name\": \"unisex-jersey-t-shirt\",\n \"brand\": \"Bella+Canvas\",\n \"createdAt\": \"2020-06-02T21:20:17.566Z\",\n \"updatedAt\": \"2020-08-12T18:09:44.610Z\",\n \"weight\": {\n \"units\": \"oz\",\n \"value\": 7\n },\n \"artworkFileSettings\": {\n \"dpi\": 150\n }\n }\n \n}"}],"_postman_id":"eb5a53c9-3cc1-4ed8-9312-d9ac6be32775"}],"id":"5e3e8ea8-b8be-4676-ab53-147a33850b1a","_postman_id":"5e3e8ea8-b8be-4676-ab53-147a33850b1a","description":""},{"name":"Stock API","item":[{"name":"Get Product Variant Stock","id":"7d466319-c5cc-47b6-be94-e6c416109aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/stock/sku/:variantSku/vendor/{{vendorId}}","urlObject":{"path":["{{version}}","stock","sku",":variantSku","vendor","{{vendorId}}"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"a8278999-c953-4338-8c00-fa2f2e2e3680","type":"any","value":"","key":"variantSku"}]}},"response":[{"id":"07ecaf79-b261-4cf1-ba16-2ff4bf3e964b","name":"Get Product Variant Stock - Success","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/stock/sku/SUKA110_BK_XL/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"sku\": \"SUKA110_BK_XL\",\n \"skuCode\": \"SUKA110\",\n \"count\": 99,\n \"inStock\": true\n}"},{"id":"9de294ec-f586-4e6c-8edf-8ddb60d8542a","name":"Get Product Variant Stock - Out-of-Stock","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/stock/sku/SUKA110_BK_XL/vendor/{{vendorId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"sku\": \"SUKA110_BK_XL\",\n \"skuCode\": \"SUKA110\",\n \"count\": 0,\n \"inStock\": false\n}"},{"id":"b299b8c3-e9ac-4980-ab94-2fc51aa406ce","name":"Get Product Variant Stock - Invalid Request","originalRequest":{"method":"GET","header":[],"url":"{{baseUrl}}/{{version}}/stock/sku/wrongsku/vendor/{{vendorId}}"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"The specified sku is invalid / not properly formatted\",\n \"errorCode\": \"ItemSkuIssue\",\n \"rawError\": \"error here\"\n}"}],"_postman_id":"7d466319-c5cc-47b6-be94-e6c416109aee"},{"name":"http://localhost:3600/api/v2/stock/vendor/printify?offset=0&limit=2","id":"4f765b75-844c-4926-ba81-70b15378e51a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3600/api/v2/stock/vendor/printify?offset=0&limit=2","urlObject":{"protocol":"http","port":"3600","path":["api","v2","stock","vendor","printify"],"host":["localhost"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"2"}],"variable":[]}},"response":[],"_postman_id":"4f765b75-844c-4926-ba81-70b15378e51a"},{"name":"http://localhost:3600/api/v2/stock/sku/3001_AQUA_XS/vendor/printify","id":"09837220-8503-4c03-b8b3-2da44a0695ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"http://localhost:3600/api/v2/stock/sku/3001_AQUA_XS/vendor/printify","urlObject":{"protocol":"http","port":"3600","path":["api","v2","stock","sku","3001_AQUA_XS","vendor","printify"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"09837220-8503-4c03-b8b3-2da44a0695ba"}],"id":"219cdcb4-a7e6-468c-ab71-92aa86b7c3e4","description":"

The new Stock API provides the ability to check the stock / inventory levels for a product or specific product variant. This allows your system to have better control over the flow of your orders based on our stock availability.

Depending on your system's requirements, you might want to check the stock availability of a product before its queued up for production push. For instance, if stock levels for a particular product variant are low, you might choose to prevent the order from being pushed to production until its stock levels update to a desirable count.

Ideally, you if the product variant is \"out-of-stock\" or the stock level is very low, you should choose not to send the order to production until the stock levels recover on our end. If you choose to push the order for production regardless, just be aware that your order might experience production delays.

Vendors might choose to develop an scheduled mechanism that calls our STOCK API regularly checking stock levels for different products and reports back to your system internal orders queue.

\n","_postman_id":"219cdcb4-a7e6-468c-ab71-92aa86b7c3e4"}],"event":[{"listen":"prerequest","script":{"id":"91feeb2c-b843-45e6-90d1-4e40813c3d8f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3713acd5-5121-415c-aa44-392c53d9b3d4","type":"text/javascript","exec":[""]}}]}