{"info":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","description":"

A comprehensive API for managing wholesale products, variants, stock levels, and printing capabilities. This API serves as an integration layer between your application and the Wholesale Merchandise product ecosystem.

Key Features

Product Management: Complete product information including:
\n
- Basic product details (name, descriptions, dimensions)
  \n
- Physical specifications (weights, measurements, packaging details)
  \n
- Categorization and classification
  \n
- Country of origin and brand information
  \n
- Digital assets and media
  \n
- Product variants with color and category details
  \n
\n
Stock Management: Real-time stock information including:
\n
- Current stock levels
  \n
- First arrival dates and quantities
  \n
- Next arrival dates and quantities
  \n
- Historical stock data tracking
  \n
\n
Pricing System: Comprehensive pricing functionality:
\n
- Product base prices
  \n
- Price scaling based on quantity
  \n
- Special price details and conditions
  \n
- Print-specific pricing
  \n
\n
Print Management: Advanced printing capabilities:
\n
- Print positions and techniques
  \n
- Print cost calculations
  \n
- Color options and manipulations
  \n
- Technical specifications for printing
  \n
\n

Authentication

This API uses Bearer Token for authentication. Protected endpoints require a valid Bearer token in the Authorization header. The staging and live tokens will be issued to you by the Wholesale Merchandise representative.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8465741","collectionId":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","publishedId":"2sAYdio9oj","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-03T13:15:48.000Z"},"item":[{"name":"Products","item":[{"name":"Products JSON","id":"37ff31d1-b863-4adf-a510-f6d303949916","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-Gateway-APIKey","value":"your API Key here"}],"url":"https://staging.trademerch.co.uk/api/products","description":"

Get All Products

Returns a list of all products with their associated digital assets and variants. This endpoint provides comprehensive product information suitable for catalog display and inventory management. The response includes all the details, like the product code, master ID, category, and a list of all available
attributes (depends on product)

Product API Response Examples

Success Response

Status Code: 200 OK

[\n    {\n        \"master_code\": \"12345\",\n        \"master_id\": \"ABC123\",\n        \"type_of_products\": \"Apparel\",\n        \"commodity_code\": \"61091000\",\n        \"number_of_print_positions\": 4,\n        \"country_of_origin\": \"Bangladesh\",\n        \"brand\": \"EcoWear\",\n        \"product_name\": \"Premium Cotton T-Shirt\",\n        \"category_code\": \"TSHIRT\",\n        \"product_class\": \"Premium\",\n        \"dimensions\": \"30x20x2\",\n        \"length\": 30,\n        \"length_unit\": \"cm\",\n        \"width\": 20,\n        \"width_unit\": \"cm\",\n        \"height\": 2,\n        \"height_unit\": \"cm\",\n        \"volume\": 1200,\n        \"volume_unit\": \"cm3\",\n        \"gross_weight\": 250,\n        \"gross_weight_unit\": \"g\",\n        \"net_weight\": 200,\n        \"net_weight_unit\": \"g\",\n        \"inner_carton_quantity\": 10,\n        \"outer_carton_quantity\": 50,\n        \"carton_length\": 60,\n        \"carton_length_unit\": \"cm\",\n        \"carton_width\": 40,\n        \"carton_width_unit\": \"cm\",\n        \"carton_height\": 30,\n        \"carton_height_unit\": \"cm\",\n        \"carton_volume\": 72000,\n        \"carton_volume_unit\": \"cm3\",\n        \"carton_gross_weight\": 12.5,\n        \"carton_gross_weight_unit\": \"kg\",\n        \"timestamp\": \"2025-02-28T12:00:00Z\",\n        \"short_description\": \"Premium quality cotton t-shirt\",\n        \"long_description\": \"100% organic cotton t-shirt with reinforced stitching and premium finish\",\n        \"material\": \"100% Cotton\",\n        \"printable\": true,\n        \"digital_assets\": [\n            {\n                \"url\": \"https://example.com/images/t-shirt-front.jpg\",\n                \"type\": \"image\",\n                \"subtype\": \"front\"\n            },\n            {\n                \"url\": \"https://example.com/images/t-shirt-back.jpg\",\n                \"type\": \"image\",\n                \"subtype\": \"back\"\n            }\n        ],\n        \"variants\": [\n            {\n                \"variant_id\": \"VAR-001\",\n                \"sku\": \"TS-BLK-M\",\n                \"release_date\": \"2025-01-01\",\n                \"discontinued_date\": null,\n                \"product_proposition_category\": \"Premium\",\n                \"category_level1\": \"Apparel\",\n                \"category_level2\": \"T-Shirts\",\n                \"category_level3\": \"Short Sleeve\",\n                \"color_description\": \"Black\",\n                \"color_group\": \"Dark\",\n                \"plc_status\": \"Active\",\n                \"plc_status_description\": \"In Production\",\n                \"gtin\": \"1234567890123\",\n                \"color_code\": \"BLK\",\n                \"pms_color\": \"Black 6 C\",\n                \"digital_assets\": [\n                    {\n                        \"url\": \"https://example.com/images/t-shirt-black-front.jpg\",\n                        \"url_highress\": \"https://example.com/images/t-shirt-black-front-hr.jpg\",\n                        \"type\": \"image\",\n                        \"subtype\": \"front\"\n                    }\n                ]\n            }\n        ]\n    }\n]\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"No products found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Get Single Product

Returns detailed information about a specific product by its master code, including all associated digital assets and variants. This endpoint is useful for detailed product views and inventory management of specific items.

Request Parameters

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

Parameter	Type	Required	Description
masterCode	string	Yes	Unique master code of product

Success Response

Status Code: 200 OK

{\n    \"master_code\": \"12345\",\n    \"master_id\": \"ABC123\",\n    \"type_of_products\": \"Apparel\",\n    \"commodity_code\": \"61091000\",\n    \"number_of_print_positions\": 4,\n    \"country_of_origin\": \"Bangladesh\",\n    \"brand\": \"EcoWear\",\n    \"product_name\": \"Premium Cotton T-Shirt\",\n    \"category_code\": \"TSHIRT\",\n    \"product_class\": \"Premium\",\n    \"dimensions\": \"30x20x2\",\n    \"length\": 30,\n    \"length_unit\": \"cm\",\n    \"width\": 20,\n    \"width_unit\": \"cm\",\n    \"height\": 2,\n    \"height_unit\": \"cm\",\n    \"volume\": 1200,\n    \"volume_unit\": \"cm3\",\n    \"gross_weight\": 250,\n    \"gross_weight_unit\": \"g\",\n    \"net_weight\": 200,\n    \"net_weight_unit\": \"g\",\n    \"inner_carton_quantity\": 10,\n    \"outer_carton_quantity\": 50,\n    \"carton_length\": 60,\n    \"carton_length_unit\": \"cm\",\n    \"carton_width\": 40,\n    \"carton_width_unit\": \"cm\",\n    \"carton_height\": 30,\n    \"carton_height_unit\": \"cm\",\n    \"carton_volume\": 72000,\n    \"carton_volume_unit\": \"cm3\",\n    \"carton_gross_weight\": 12.5,\n    \"carton_gross_weight_unit\": \"kg\",\n    \"timestamp\": \"2025-02-28T12:00:00Z\",\n    \"short_description\": \"Premium quality cotton t-shirt\",\n    \"long_description\": \"100% organic cotton t-shirt with reinforced stitching and premium finish\",\n    \"material\": \"100% Cotton\",\n    \"printable\": true,\n    \"digital_assets\": [\n        {\n            \"url\": \"https://example.com/images/t-shirt-front.jpg\",\n            \"type\": \"image\",\n            \"subtype\": \"front\"\n        },\n        {\n            \"url\": \"https://example.com/images/t-shirt-back.jpg\",\n            \"type\": \"image\",\n            \"subtype\": \"back\"\n        }\n    ],\n    \"variants\": [\n        {\n            \"variant_id\": \"VAR-001\",\n            \"sku\": \"TS-BLK-M\",\n            \"release_date\": \"2025-01-01\",\n            \"discontinued_date\": null,\n            \"product_proposition_category\": \"Premium\",\n            \"category_level1\": \"Apparel\",\n            \"category_level2\": \"T-Shirts\",\n            \"category_level3\": \"Short Sleeve\",\n            \"color_description\": \"Black\",\n            \"color_group\": \"Dark\",\n            \"plc_status\": \"Active\",\n            \"plc_status_description\": \"In Production\",\n            \"gtin\": \"1234567890123\",\n            \"color_code\": \"BLK\",\n            \"pms_color\": \"Black 6 C\",\n            \"digital_assets\": [\n                {\n                    \"url\": \"https://example.com/images/t-shirt-black-front.jpg\",\n                    \"url_highress\": \"https://example.com/images/t-shirt-black-front-hr.jpg\",\n                    \"type\": \"image\",\n                    \"subtype\": \"front\"\n                }\n            ]\n        }\n    ]\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"Product not found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Invalid Master Code

Status Code: 400 Bad Request

{\n    \"message\": \"Invalid master code format\",\n    \"error\": \"ValidationError\",\n    \"status_code\": 400\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Product Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
master_code	string	Unique identifier for the product
master_id	string	Internal master ID
product_name	string	Name of the product
brand	string	Brand name
category_code	string	Product category code
dimensions	string	Combined dimensions string
printable	boolean	Whether product can be printed on

Measurement Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
length	number	Product length
length_unit	string	Unit of length measurement
width	number	Product width
width_unit	string	Unit of width measurement
height	number	Product height
height_unit	string	Unit of height measurement
volume	number	Product volume
volume_unit	string	Unit of volume measurement

Weight Fields

\n\n\n\n\n\n\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
gross_weight	number	Gross weight of product
gross_weight_unit	string	Unit of gross weight
net_weight	number	Net weight of product
net_weight_unit	string	Unit of net weight

Carton Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
inner_carton_quantity	integer	Quantity in inner carton
outer_carton_quantity	integer	Quantity in outer carton
carton_length	number	Length of carton
carton_width	number	Width of carton
carton_height	number	Height of carton
carton_volume	number	Volume of carton
carton_gross_weight	number	Gross weight of carton

Digital Asset Fields

\n\n\n\n\n\n\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
url	string	URL of the digital asset
type	string	Type of asset (image, document, etc)
subtype	string	Subtype of asset (front, back, etc)
url_highress	string	High resolution URL (variants only)

Variant Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
variant_id	string	Unique identifier for the variant
sku	string	Stock Keeping Unit code
release_date	string	Date when variant was released (ISO 8601)
discontinued_date	string	Date when variant was discontinued (ISO 8601)
product_proposition_category	string	Product proposition category
category_level1	string	Top level category classification
category_level2	string	Second level category classification
category_level3	string	Third level category classification
color_description	string	Human readable color description
color_group	string	Color grouping (e.g., Dark, Light, Vibrant)
plc_status	string	Product Life Cycle status
plc_status_description	string	Description of the PLC status
gtin	string	Global Trade Item Number
color_code	string	Color code identifier
pms_color	string	Pantone Matching System color code

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}},"urlObject":{"path":["api","products","master_code"],"host":["https://staging.trademerch.co.uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb753152-0d7c-4b52-8d18-aa64c112b8b3"}],"id":"f026a978-25ca-4a4c-97db-2eeebb840add","_postman_id":"f026a978-25ca-4a4c-97db-2eeebb840add","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}}},{"name":"Stocks","item":[{"name":"Stocks JSON","id":"26910872-a713-4043-95f8-71e69e570253","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-Gateway-APIKey","value":"your API Key here"}],"url":"https://staging.trademerch.co.uk/api/stocks","description":"

Get All Stocks

Returns the latest stock information for all products, including current quantities and upcoming arrivals.

Request

Method

GET

URL

{{base_url}}/api/stocks\n\n

Headers

Accept: application/json\n\n

Response

Success Response (200 OK)

{\n    \"modified_at\": \"2025-02-28T12:00:00Z\",\n    \"stock\": [\n        {\n            \"sku\": \"TS-BLK-M\",\n            \"qty\": 150,\n            \"first_arrival_date\": \"2025-03-15\",\n            \"first_arrival_qty\": 500,\n            \"next_arrival_date\": \"2025-04-01\",\n            \"next_arrival_qty\": 1000\n        },\n        {\n            \"sku\": \"TS-WHT-L\",\n            \"qty\": 75,\n            \"first_arrival_date\": \"2025-03-20\",\n            \"first_arrival_qty\": 300,\n            \"next_arrival_date\": \"2025-04-15\",\n            \"next_arrival_qty\": 800\n        }\n    ]\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"No stock data found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Stock Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
modified_at	string	Timestamp of last stock update (ISO 8601 format)
stock	array	Array of stock items
sku	string	Stock Keeping Unit - unique product identifier
qty	integer	Current available quantity
first_arrival_date	string	Date of next expected stock arrival (YYYY-MM-DD)
first_arrival_qty	integer	Quantity expected in next arrival
next_arrival_date	string	Date of subsequent stock arrival (YYYY-MM-DD)
next_arrival_qty	integer	Quantity expected in subsequent arrival

Get Stock by SKU

Returns detailed stock information for a specific product SKU.

Request

Method

GET

URL

{{base_url}}/api/stocks/{sku}\n\n

Headers

Accept: application/json\n\n

URL Parameters

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

Parameter	Type	Required	Description
sku	string	Yes	Product SKU to lookup

Response

Success Response (200 OK)

{\n    \"modified_at\": \"2025-02-28T12:00:00Z\",\n    \"stock\": {\n        \"sku\": \"TS-BLK-M\",\n        \"qty\": 150,\n        \"first_arrival_date\": \"2025-03-15\",\n        \"first_arrival_qty\": 500,\n        \"next_arrival_date\": \"2025-04-01\",\n        \"next_arrival_qty\": 1000\n    }\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"Stock not found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Stock Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
modified_at	string	Timestamp of last stock update (ISO 8601 format)
stock	object	Stock information object
sku	string	Stock Keeping Unit - unique product identifier
qty	integer	Current available quantity
first_arrival_date	string	Date of next expected stock arrival (YYYY-MM-DD)
first_arrival_qty	integer	Quantity expected in next arrival
next_arrival_date	string	Date of subsequent stock arrival (YYYY-MM-DD)
next_arrival_qty	integer	Quantity expected in subsequent arrival

This collection contains endpoints for retrieving real-time stock information for products. Get current stock levels, upcoming arrivals, and stock details for specific SKUs. Stock information is updated every hour.

The stock API returns the available stock in our warehouse and the next two stock arrivals if applicable. In this case it tells us that item WSM-KC2364-37 does not have current stock, but on 25/08/2023 3000 pcs will arrive to the Warehouse and also another shipment will arrive on 22/09/2023 with 5000 extra pcs.

Available Endpoints

Get All Stocks (GET /api/stocks)
\n
Get Stock by SKU (GET /api/stocks/{sku})
\n

\n","_postman_id":"64064c10-30fc-43f4-873e-ebbf388c3996","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}}},{"name":"Prints","item":[{"name":"Prints JSON","id":"8925f4e3-ab24-42b3-9976-fcc5b1e7daa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-Gateway-APIKey","value":"your API Key here"}],"url":"https://staging.trademerch.co.uk/api/prints","description":"

Get All Prints

Returns printing information for all products, including print positions, techniques, and specifications.

Request

Method

GET

URL

{{base_url}}/api/prints\n\n

Headers

Accept: application/json\n\n

Response

Success Response (200 OK)

{\n    \"products\": [\n        {\n            \"master_code\": \"12345\",\n            \"master_id\": \"ABC123\",\n            \"print_manipulation\": \"allowed\",\n            \"print_template\": \"template_url\",\n            \"item_color_numbers\": [\n                \"1\",\n                \"2\",\n                \"3\"\n            ],\n            \"printing_positions\": [\n                {\n                    \"position_id\": \"front\",\n                    \"print_size_unit\": \"cm\",\n                    \"max_print_size_height\": 20,\n                    \"max_print_size_width\": 15,\n                    \"rotation\": 0,\n                    \"print_position_type\": \"standard\",\n                    \"points\": [\n                        {\n                            \"sequence_no\": 1,\n                            \"distance_from_left\": 10,\n                            \"distance_from_top\": 5\n                        }\n                    ],\n                    \"images\": [\n                        {\n                            \"variant_color\": \"black\",\n                            \"print_position_image_blank\": \"blank_image_url\",\n                            \"print_position_image_with_area\": \"area_image_url\"\n                        }\n                    ],\n                    \"printing_techniques\": [\n                        {\n                            \"id\": \"screen\",\n                            \"default\": true,\n                            \"max_colours\": 4\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"No print data found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Product Fields

\n\n\n\n\n\n\n\n\n\n\n\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
master_code	string	Unique identifier for the product
master_id	string	Internal master ID
print_manipulation	string	Whether print manipulation is allowed
print_template	string	URL of the print template
item_color_numbers	array	Array of available color numbers

Printing Position Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
position_id	string	Identifier for print position (e.g., \"front\")
print_size_unit	string	Unit for print size measurements
max_print_size_height	number	Maximum allowed print height
max_print_size_width	number	Maximum allowed print width
rotation	number	Rotation angle in degrees
print_position_type	string	Type of print position

Print Point Fields

\n\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
sequence_no	integer	Sequence number of the point
distance_from_left	number	Distance from left edge
distance_from_top	number	Distance from top edge

Print Image Fields

\n\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
variant_color	string	Color variant identifier
print_position_image_blank	string	URL of blank position image
print_position_image_with_area	string	URL of position image with print area marked

Printing Technique Fields

\n\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
id	string	Identifier for the printing technique
default	boolean	Whether this is the default technique
max_colours	integer	Maximum number of colors allowed

Get Print Details

Returns detailed printing information for a specific product, including print positions, techniques, and specifications.

Request

Method

GET

URL

{{base_url}}/api/prints/{masterCode}\n\n

Headers

Accept: application/json\n\n

URL Parameters

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

Parameter	Type	Required	Description
masterCode	string	Yes	Product's master code

Response

Success Response (200 OK)

{\n    \"master_code\": \"12345\",\n    \"master_id\": \"ABC123\",\n    \"print_manipulation\": \"allowed\",\n    \"print_template\": \"template_url\",\n    \"item_color_numbers\": [\n        \"1\",\n        \"2\",\n        \"3\"\n    ],\n    \"printing_positions\": [\n        {\n            \"position_id\": \"front\",\n            \"print_size_unit\": \"cm\",\n            \"max_print_size_height\": 20,\n            \"max_print_size_width\": 15,\n            \"rotation\": 0,\n            \"print_position_type\": \"standard\",\n            \"points\": [\n                {\n                    \"sequence_no\": 1,\n                    \"distance_from_left\": 10,\n                    \"distance_from_top\": 5\n                }\n            ],\n            \"images\": [\n                {\n                    \"variant_color\": \"black\",\n                    \"print_position_image_blank\": \"blank_image_url\",\n                    \"print_position_image_with_area\": \"area_image_url\"\n                }\n            ],\n            \"printing_techniques\": [\n                {\n                    \"id\": \"screen\",\n                    \"default\": true,\n                    \"max_colours\": 4\n                }\n            ]\n        }\n    ]\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"Print data not found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Invalid Master Code

Status Code: 400 Bad Request

{\n    \"message\": \"Invalid master code format\",\n    \"error\": \"ValidationError\",\n    \"status_code\": 400\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Product Fields

\n\n\n\n\n\n\n\n\n\n\n\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
master_code	string	Unique identifier for the product
master_id	string	Internal master ID
print_manipulation	string	Whether print manipulation is allowed
print_template	string	URL of the print template
item_color_numbers	array	Array of available color numbers

Printing Position Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
position_id	string	Identifier for print position (e.g., \"front\")
print_size_unit	string	Unit for print size measurements
max_print_size_height	number	Maximum allowed print height
max_print_size_width	number	Maximum allowed print width
rotation	number	Rotation angle in degrees
print_position_type	string	Type of print position

Print Point Fields

\n\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
sequence_no	integer	Sequence number of the point
distance_from_left	number	Distance from left edge
distance_from_top	number	Distance from top edge

Print Image Fields

\n\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
variant_color	string	Color variant identifier
print_position_image_blank	string	URL of blank position image
print_position_image_with_area	string	URL of position image with print area marked

Printing Technique Fields

\n\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
id	string	Identifier for the printing technique
default	boolean	Whether this is the default technique
max_colours	integer	Maximum number of colors allowed

Prints

This collection contains endpoints for retrieving printing-related information for products. Get details of all the Printing options that are available for the products, print positions, available printing techniques per position, the max print size, max print colors and template images of the positions.

The Print data contains the specifics of printing of each single item in our collection, every time that there is a change on the printing information of a product in our system the file is updated overnight. Printing Data has the following features:
▪ Can be requested via REST API, in json format.
▪ Includes Printing Information about Textiles
▪ Product variants are not separated since they have the same printing information.
▪ Shows specifics print area points.

The printdata file starts with a set of labels with the translations of each Printing Technique in the different languages, so you will not need to make the translations as they can be picked up directly from the data.

After that information you will get an specific data about the printing options per item. Please, notice that in this case the relation is N:1 as the printing information is the same for the different colours of an item. In this case you can relate the Product Information file with the Printing Information file by the label “master_code”. The tag “print_manipulation” specifices the manipulation group of an item, it can be A, B, C, D, E or Z (in some cases if there is none the code will show as null).
If you search this letter code in the print pricelist file you can get the prices for the handling of a product.

Available Endpoints

Get All Prints (GET /api/prints)
\n
Get Print Details (GET /api/prints/{masterCode})
\n

\n","_postman_id":"4047a9db-fb14-4391-ac13-dd77674405b7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}}},{"name":"Product Prices","item":[{"name":"Product Prices JSON","id":"16d68ed7-b1f0-4e98-a8fa-77115c4472d8","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-Gateway-APIKey","value":"your API Key here"}],"url":"https://staging.trademerch.co.uk/api/stocks/prices","description":"

Get All Prices

Returns the latest price information for all products, including base prices and quantity-based price scales.

Request

Method

GET

URL

{{base_url}}/api/prices\n\n

Headers

Accept: application/json\n\n

Response

Success Response (200 OK)

{\n    \"currency\": \"EUR\",\n    \"date\": \"2025-02-28\",\n    \"price\": [\n        {\n            \"sku\": \"TS-BLK-M\",\n            \"variant_id\": \"VAR-001\",\n            \"price\": 19.99,\n            \"valid_until\": \"2025-12-31\",\n            \"scale\": [\n                {\n                    \"minimum_quantity\": 1,\n                    \"price\": 19.99\n                },\n                {\n                    \"minimum_quantity\": 50,\n                    \"price\": 17.99\n                },\n                {\n                    \"minimum_quantity\": 100,\n                    \"price\": 15.99\n                }\n            ]\n        }\n    ]\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"No price data found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Price Detail Fields

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

Field	Type	Description
currency	string	Currency code (e.g., \"EUR\", \"USD\")
date	string	Date of price data (YYYY-MM-DD)

Price Fields

\n\n\n\n\n\n\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
sku	string	Stock Keeping Unit - unique product identifier
variant_id	string	Variant identifier
price	number	Base price for the product
valid_until	string	Price validity end date (YYYY-MM-DD)

Price Scale Fields

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

Field	Type	Description
minimum_quantity	integer	Minimum quantity for this price tier
price	number	Price per unit at this quantity tier

Get Price by SKU

Returns detailed price information for a specific product SKU, including base price and quantity-based price scales.

Request

Method

GET

URL

{{base_url}}/api/prices/{sku}\n\n

Headers

Accept: application/json\n\n

URL Parameters

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

Parameter	Type	Required	Description
sku	string	Yes	Product SKU to lookup

Response

Success Response (200 OK)

{\n    \"currency\": \"EUR\",\n    \"date\": \"2025-02-28\",\n    \"price\": {\n        \"sku\": \"TS-BLK-M\",\n        \"variant_id\": \"VAR-001\",\n        \"price\": 19.99,\n        \"valid_until\": \"2025-12-31\",\n        \"scale\": [\n            {\n                \"minimum_quantity\": 1,\n                \"price\": 19.99\n            },\n            {\n                \"minimum_quantity\": 50,\n                \"price\": 17.99\n            },\n            {\n                \"minimum_quantity\": 100,\n                \"price\": 15.99\n            }\n        ]\n    }\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"Price not found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Invalid SKU

Status Code: 400 Bad Request

{\n    \"message\": \"Invalid SKU format\",\n    \"error\": \"ValidationError\",\n    \"status_code\": 400\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Price Detail Fields

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

Field	Type	Description
currency	string	Currency code (e.g., \"EUR\", \"USD\")
date	string	Date of price data (YYYY-MM-DD)

Price Fields

\n\n\n\n\n\n\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
sku	string	Stock Keeping Unit - unique product identifier
variant_id	string	Variant identifier
price	number	Base price for the product
valid_until	string	Price validity end date (YYYY-MM-DD)

Price Scale Fields

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

Field	Type	Description
minimum_quantity	integer	Minimum quantity for this price tier
price	number	Price per unit at this quantity tier

Prices

This collection contains the specific customer pricing per item (any discount or condition that you have will be reflected on this file).

The output will be a complete file with the specific customer pricing (based on the api key on the input) for the entire Product assortment. You will have to integrate the content of the output json file into your database.

Available Endpoints

Get All Prices (GET /api/prices)
\n
Get Price Details (GET /api/prices/{sku})
\n

\n","_postman_id":"536a07ef-c8a5-4351-aa95-c2b12ba0bca2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}}},{"name":"Print Prices","item":[{"name":"Print Prices JSON","id":"40cbdeac-65f8-48b5-bfc4-aa33fb5ee20a","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-Gateway-APIKey","value":"your API Key here"}],"url":"https://staging.trademerch.co.uk/api/print-prices","description":"

Get All Print Prices

Returns pricing information for all print techniques and manipulations, including setup costs and quantity-based price scales.

Request

Method

GET

URL

{{base_url}}/api/print-prices\n\n

Headers

Accept: application/json\n\n

Response

Success Response (200 OK)

{\n    \"currency\": \"EUR\",\n    \"pricelist_valid_from\": \"2025-01-01\",\n    \"pricelist_valid_until\": \"2025-12-31\",\n    \"print_manipulations\": [\n        {\n            \"code\": \"PREP\",\n            \"description\": \"Artwork preparation\",\n            \"price\": 25.00\n        }\n    ],\n    \"print_techniques\": [\n        {\n            \"id\": \"SCREEN\",\n            \"description\": \"Screen printing\",\n            \"pricing_type\": \"quantity_based\",\n            \"setup\": 50.00,\n            \"setup_repeat\": 25.00,\n            \"next_colour_cost_indicator\": \"true\",\n            \"var_costs\": [\n                {\n                    \"range_id\": 1,\n                    \"area_from\": 0,\n                    \"area_to\": 50,\n                    \"scales\": [\n                        {\n                            \"minimum_quantity\": 1,\n                            \"price\": 2.50,\n                            \"next_price\": 1.50\n                        },\n                        {\n                            \"minimum_quantity\": 50,\n                            \"price\": 2.00,\n                            \"next_price\": 1.25\n                        },\n                        {\n                            \"minimum_quantity\": 100,\n                            \"price\": 1.75,\n                            \"next_price\": 1.00\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"No print price data found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Price List Fields

\n\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
currency	string	Currency code (e.g., \"EUR\", \"USD\")
pricelist_valid_from	string	Start date of price list validity (YYYY-MM-DD)
pricelist_valid_until	string	End date of price list validity (YYYY-MM-DD)

Print Manipulation Fields

\n\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
code	string	Unique identifier for the manipulation
description	string	Description of the manipulation
price	number	Cost of the manipulation

Print Technique Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
id	string	Unique identifier for the technique
description	string	Description of the printing technique
pricing_type	string	Type of pricing (e.g., \"quantity_based\")
setup	number	Initial setup cost
setup_repeat	number	Setup cost for repeat orders
next_colour_cost_indicator	string	Whether additional colors affect price (\"true\"/\"false\")

Variable Cost Fields

\n\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
range_id	integer	Identifier for the price range
area_from	number	Starting print area for this range
area_to	number	Ending print area for this range

Cost Scale Fields

\n\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
minimum_quantity	integer	Minimum quantity for this price tier
price	number	Price per unit at this quantity tier
next_price	number	Price per unit for additional colors (optional)

Get Print Technique Price

Returns detailed pricing information for a specific print technique, including setup costs, manipulations, and quantity-based price scales.

Request

Method

GET

URL

{{base_url}}/api/print-prices/{techniqueCode}\n\n

Headers

Accept: application/json\n\n

URL Parameters

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

Parameter	Type	Required	Description
techniqueCode	string	Yes	Print technique code to lookup

Response

Success Response (200 OK)

{\n    \"currency\": \"EUR\",\n    \"pricelist_valid_from\": \"2025-01-01\",\n    \"pricelist_valid_until\": \"2025-12-31\",\n    \"print_manipulations\": [\n        {\n            \"code\": \"PREP\",\n            \"description\": \"Artwork preparation\",\n            \"price\": 25.00\n        }\n    ],\n    \"print_technique\": {\n        \"id\": \"SCREEN\",\n        \"description\": \"Screen printing\",\n        \"pricing_type\": \"quantity_based\",\n        \"setup\": 50.00,\n        \"setup_repeat\": 25.00,\n        \"next_colour_cost_indicator\": \"true\",\n        \"var_costs\": [\n            {\n                \"range_id\": 1,\n                \"area_from\": 0,\n                \"area_to\": 50,\n                \"scales\": [\n                    {\n                        \"minimum_quantity\": 1,\n                        \"price\": 2.50,\n                        \"next_price\": 1.50\n                    },\n                    {\n                        \"minimum_quantity\": 50,\n                        \"price\": 2.00,\n                        \"next_price\": 1.25\n                    },\n                    {\n                        \"minimum_quantity\": 100,\n                        \"price\": 1.75,\n                        \"next_price\": 1.00\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

Error Responses

Not Found

Status Code: 404 Not Found

{\n    \"message\": \"Print technique not found\",\n    \"error\": \"NotFoundError\",\n    \"status_code\": 404\n}\n\n

Invalid Technique Code

Status Code: 400 Bad Request

{\n    \"message\": \"Invalid technique code format\",\n    \"error\": \"ValidationError\",\n    \"status_code\": 400\n}\n\n

Server Error

Status Code: 500 Internal Server Error

{\n    \"message\": \"Internal server error occurred\",\n    \"error\": \"InternalServerError\",\n    \"status_code\": 500\n}\n\n

Response Fields Description

Price List Fields

\n\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
currency	string	Currency code (e.g., \"EUR\", \"USD\")
pricelist_valid_from	string	Start date of price list validity (YYYY-MM-DD)
pricelist_valid_until	string	End date of price list validity (YYYY-MM-DD)

Print Manipulation Fields

\n\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
code	string	Unique identifier for the manipulation
description	string	Description of the manipulation
price	number	Cost of the manipulation

Print Technique Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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
id	string	Unique identifier for the technique
description	string	Description of the printing technique
pricing_type	string	Type of pricing (e.g., \"quantity_based\")
setup	number	Initial setup cost
setup_repeat	number	Setup cost for repeat orders
next_colour_cost_indicator	string	Whether additional colors affect price (\"true\"/\"false\")

Variable Cost Fields

\n\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
range_id	integer	Identifier for the price range
area_from	number	Starting print area for this range
area_to	number	Ending print area for this range

Cost Scale Fields

\n\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
minimum_quantity	integer	Minimum quantity for this price tier
price	number	Price per unit at this quantity tier
next_price	number	Price per unit for additional colors (optional)

Print Prices

This collection contains endpoints for retrieving pricing information related to printing services. Get details about print technique costs, manipulations, setup costs, and quantity-based price scales.

The print pricelist starts with a header that shows the pricelist currency, validity date.
After that there’s a section with the different print manipulations prices and codes to relate to the printing data information.

Next it shows the manipulation (handling) prices based on the code available in the Print Data in the field “print_manipulation”

The printing specific section, here you can check the ID based on info in Print Data, the pricing type, which defines the way that the prices are calculated for the print technique.

Below is a table that contains examples of calculations for each pricing type. If a cell is colored grey, it means that for that pricing type that information is not important.

\n\n

Available Endpoints

Get All Print Prices (GET /api/print-prices)
\n
Get Print Technique Price (GET /api/print-prices/{techniqueCode})
\n

\n","_postman_id":"dfa26451-ca9d-47a4-83b6-861ee95252e4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}}},{"name":"Shipping","item":[{"name":"Calculate Shipping","id":"fdede7de-96dc-4d36-82cc-c8df9aac7d1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"units\": 4, \n \"weight\": 25,\n \"order_value\": 500\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.trademerch.co.uk/api/shipping/calculate","description":"

Calculate Shipping

Calculates shipping costs and delivery time based on order details. This endpoint determines shipping parameters by analyzing the number of units, total weight, and order value against predefined shipping rules.

Endpoint

POST /api/shipping/calculate

Authentication

Requires Bearer token authentication via Sanctum.

Request Body

{\n    \"units\": 100,\n    \"weight\": 25.5,\n    \"order_value\": 999.99\n}\n

Fields

\n\n\n\n\n\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	Required
units	integer	Number of items in the order (minimum: 1)	Yes
weight	number	Total weight of the order in kg (minimum: 0)	Yes
order_value	number	Total monetary value of the order (minimum: 0)	Yes

Success Response

Status Code: 200 OK

{\n    \"shipping_time\": 3,\n    \"shipping_price\": 15.99\n}\n

Response Fields

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

Field	Type	Description
shipping_time	integer	Estimated delivery time in business days
shipping_price	number	Calculated shipping cost in the same currency as order_value

Error Responses

Validation Error

Status Code: 422 Unprocessable Entity

{\n    \"error\": \"Validation failed\",\n    \"messages\": {\n        \"units\": [\n            \"The units field is required.\",\n            \"The units must be at least 1.\"\n        ],\n        \"weight\": [\n            \"The weight field is required.\",\n            \"The weight must be at least 0.\"\n        ],\n        \"order_value\": [\n            \"The order value field is required.\",\n            \"The order value must be at least 0.\"\n        ]\n    }\n}\n

Authentication Error

Status Code: 401 Unauthorized

{\n    \"message\": \"Unauthenticated.\"\n}\n

Important Notes

Shipping calculations are based on predefined rules that consider:
- Number of units ordered
- Total weight of the order
- Total order value
\n
If no specific shipping rule matches the order parameters, default values are applied:
- Shipping time: 5 business days
- Shipping price: 20.83
\n
All monetary values should be in the same currency
Weight should be provided in kilograms
Shipping time is returned in business days
The response prices are fixed based on shipping rules and do not include any dynamic calculations or real-time carrier rates

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}},"urlObject":{"path":["api","shipping","calculate"],"host":["https://staging.trademerch.co.uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"fdede7de-96dc-4d36-82cc-c8df9aac7d1a"}],"id":"41f0122b-7615-4d4d-973f-daab5c9a02b9","_postman_id":"41f0122b-7615-4d4d-973f-daab5c9a02b9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"your_api_key"}]},"isInherited":true,"source":{"_postman_id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","id":"e5383682-fcd1-4dba-98a3-7ea661e3dcf1","name":"Wholesale Merchandise API","type":"collection"}}},{"name":"Orders","item":[{"name":"Create Order","id":"604d4f8c-c50e-46ac-af87-d080d6c205a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_header\": {\n \"po_number\": \"PO123456\",\n \"currency\": \"USD\",\n \"order_type\": \"standard\",\n \"preferred_shipping_date\": \"2025-04-15\",\n \"contact_email\": \"buyer@example.com\",\n \"check_price\": true,\n \"contact_name\": \"John Doe\",\n \"company_name\": \"ABC Corp\",\n \"shipping_address\": {\n \"contact_name\": \"Jane Smith\",\n \"company_name\": \"ABC Corp Warehouse\",\n \"street1\": \"123 Shipping St\",\n \"postal_code\": \"12345\",\n \"city\": \"Warehouse City\",\n \"region\": \"State\",\n \"country\": \"United States\",\n \"email\": \"warehouse@example.com\",\n \"phone\": \"+1-555-0123\"\n }\n },\n \"order_lines\": [\n {\n \"sku\": \"TS-BLK-M\",\n \"variant_id\": \"VAR-001\",\n \"quantity\": 100,\n \"expected_price\": 9.99\n },\n {\n \"sku\": \"TS-BLK-L\",\n \"variant_id\": \"VAR-002\",\n \"quantity\": 50,\n \"expected_price\": 9.99\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://staging.trademerch.co.uk/api/orders","description":"

Create Order

Creates a new order with header information and line items. This endpoint handles order creation with comprehensive validation of stock availability and data integrity. It automatically reserves stock for ordered items and generates a unique order number.

Endpoint

POST /api/orders

Authentication

Requires Bearer token authentication via Sanctum.

Request Body

The request must include both order header information and at least one order line item.

{\n  \"order_header\": {\n    \"po_number\": \"PO-123457\",\n    \"currency\": \"EUR\",\n    \"order_type\": \"PRINT\",\n    \"preferred_shipping_date\": \"2025-06-15\",\n    \"contact_email\": \"alice.johnson@example.com\",\n    \"check_price\": true,\n    \"contact_name\": \"Alice Johnson\",\n    \"company_name\": \"Global Tech Ltd.\",\n    \"timestamp\": \"2025-06-15T10:30:00\",\n    \"shipping_address\": {\n      \"contact_name\": \"Alice Johnson\",\n      \"company_name\": \"Global Tech Ltd.\",\n      \"street1\": \"789 Innovation Road\",\n      \"postal_code\": \"20002\",\n      \"city\": \"Los Angeles\",\n      \"region\": \"CA\",\n      \"country\": \"US\",\n      \"email\": \"alice.johnson@example.com\",\n      \"phone\": \"+1-555-123-4567\"\n    }\n  },\n  \"order_lines\": [\n    {\n      \"order_line_id\": \"1\",\n      \"master_code\": \"AR1804\",\n      \"expected_price\": 150.75,\n      \"quantity\": 10,\n      \"printing_positions\": [\n        {\n          \"id\": \"FRONT\",\n          \"print_size_height\": 24,\n          \"print_size_width\": 45,\n          \"printing_technique_id\": \"S2\",\n          \"number_of_print_colors\": 1,\n          \"print_artwork_url\": \"https://example.com/artwork.ai\",\n          \"print_mockup_url\": \"https://example.com/mockup.pdf\",\n          \"print_instruction\": \"Place logo in center\",\n          \"print_colors\": [\n            {\n              \"color\": \"PMS 300C\"\n            }\n          ]\n        }\n      ],\n      \"print_items\": [\n        {\n          \"item_color_number\": \"03\",\n          \"quantity\": 50\n        },\n        {\n          \"item_color_number\": \"04\",\n          \"quantity\": 50\n        }\n      ]\n    }\n  ]\n}\n

Order Header Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Required
po_number	string	Purchase order number	Yes
currency	string	Order currency code	Yes
order_type	string	Type of order (e.g., \"standard\")	Yes
preferred_shipping_date	date	Requested shipping date (YYYY-MM-DD)	Yes
contact_email	string	Primary contact email	Yes
check_price	boolean	Whether to validate expected prices	Yes
contact_name	string	Primary contact name	Yes
company_name	string	Company name	No
shipping_address	object	Shipping address details	Yes

Shipping Address Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Required
contact_name	string	Recipient name	Yes
company_name	string	Company name for shipping	No
street1	string	Street address	Yes
postal_code	string	Postal/ZIP code	Yes
city	string	City name	Yes
region	string	State/Province/Region	Yes
country	string	Country name	Yes
email	string	Contact email for shipping	Yes
phone	string	Contact phone for shipping	Yes

Order Line Fields

Normal Order Line

\n\n\n\n\n\n\n\n\n\n\n\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	Required
sku	string	Product SKU	Yes
variant_id	string	Product variant ID	Yes
quantity	integer	Order quantity (minimum 1)	Yes
expected_price	number	Expected price per unit	Yes

Print Order Line

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Required
order_line_id	string	Unique identifier for the order line	Yes
master_code	string	Product master code	Yes
expected_price	number	Expected price per unit	Yes
quantity	integer	Order quantity	Yes
printing_positions	array	List of print positions for this line	Yes
print_items	array	List of print items for this line	Yes

Printing Position Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\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	Required
id	string	Print position identifier	Yes
print_size_height	number	Height of print area	Yes
print_size_width	number	Width of print area	Yes
printing_technique_id	string	Printing technique code	Yes
number_of_print_colors	integer	Number of print colors	Yes
print_artwork_url	string	URL to artwork file	Yes
print_mockup_url	string	URL to mockup file	No
print_instruction	string	Special instructions	No
print_colors	array	List of print colors	Yes

Print Item Object

\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	Required
item_color_number	string	Color number for item	Yes
quantity	integer	Quantity for this color	Yes

Success Response

Status Code: 201 Created

{\n    \"message\": \"Order created successfully\",\n    \"order\": {\n        \"id\": 1,\n        \"order_number\": \"ORD-65F8A9C2E4B1D\",\n        \"po_number\": \"PO123456\",\n        \"currency\": \"USD\",\n        \"order_type\": \"standard\",\n        \"preferred_shipping_date\": \"2025-04-15\",\n        \"status\": \"pending\",\n        \"contact_email\": \"buyer@example.com\",\n        \"contact_name\": \"John Doe\",\n        \"company_name\": \"ABC Corp\",\n        \"street1\": \"123 Shipping St\",\n        \"postal_code\": \"12345\",\n        \"city\": \"Warehouse City\",\n        \"region\": \"State\",\n        \"country\": \"United States\",\n        \"email\": \"warehouse@example.com\",\n        \"phone\": \"+1-555-0123\",\n        \"created_at\": \"2025-04-01T18:09:32.000000Z\",\n        \"updated_at\": \"2025-04-01T18:09:32.000000Z\"\n    }\n}\n

Error Responses

Validation Error

Status Code: 422 Unprocessable Entity

{\n    \"message\": \"The given data was invalid.\",\n    \"errors\": {\n        \"order_header.po_number\": [\n            \"The po number field is required.\"\n        ],\n        \"order_lines\": [\n            \"At least one order line is required.\"\n        ]\n    }\n}\n

Stock/Product Validation Error

Status Code: 400 Bad Request

{\n    \"message\": \"Some SKUs or Variant IDs do not exist, or stock is insufficient\",\n    \"missing_skus\": [\n        \"TS-BLK-XXL\"\n    ],\n    \"missing_variant_ids\": [\n        \"VAR-999\"\n    ],\n    \"insufficient_stock\": [\n        {\n            \"sku\": \"TS-BLK-M\",\n            \"available_qty\": 50,\n            \"requested_qty\": 100\n        }\n    ]\n}\n

Authentication Error

Status Code: 401 Unauthorized

{\n    \"message\": \"Unauthenticated.\"\n}\n

Important Notes

Stock is automatically reserved upon successful order creation
\n
Each order is assigned a unique order number prefixed with \"ORD-\"
\n
Initial order status is set to \"pending\"
\n
The API performs the following validations:
\n
- Validates all required fields
  \n
- Verifies SKU and variant existence
  \n
- Checks stock availability for requested quantities
  \n
- Validates shipping address details
  \n
\n
All prices should be provided in the specified currency
\n