{"info":{"_postman_id":"e8645c69-f17e-4e55-b966-c50b6bada4a0","name":"TradeEmbroidery API Collection","description":"

Stitch Connect is Trade Embroidery's external API to facilitate automated client ordering.

Trade Embroidery Support: apisupport@tradeembroidery.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32202552","collectionId":"e8645c69-f17e-4e55-b966-c50b6bada4a0","publishedId":"2s9YsKgs59","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-02-19T12:22:38.000Z"},"item":[{"name":"Get All Products API","id":"fdbb630d-75ea-4aaf-91c0-adec7234a495","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://tradeembroidery.com/getallproducts?token=4788-ae540d-23ad98-d19326-f27ae0375b019adcaaaf5f8f0460df3d73&offset=0&limit=20","description":"

Get All Products

This endpoint makes an HTTP GET request to retrieve a list of all products.

Request Parameters

token (query parameter) - A unique token for authentication.
offset (query parameter) - The offset for paginating through the results.
limit (query parameter) - The maximum number of items to return.

Response

Upon a successful execution, the server responds with a status code of 200 and a JSON object containing the following fields:

response_code - The response code for the request.
data (array) - An array of product objects, each containing:
- id - The unique identifier of the product.
- name - The name of the product.
- description - The description of the product.
- customisationDescription - The customisation description of the product.
- price - The price of the product.
- deliverydetails - The delivery details of the product.
- category - An object containing the id and name of the category to which the product belongs.
- available_colors - The available colors for the product.
- customization (array) - An array of customization options for the product.
\n
status - The status of the response.

Example

{\n  \"response_code\": \"\",\n  \"data\": [\n    {\n      \"id\": 0,\n      \"name\": \"\",\n      \"description\": \"\",\n      \"customisationDescription\": \"\",\n      \"price\": \"\",\n      \"deliverydetails\": \"\",\n      \"category\": {\n        \"id\": 0,\n        \"name\": \"\"\n      },\n      \"available_colors\": \"\",\n      \"customization\": [\"\"]\n    }\n  ],\n  \"status\": \"\"\n}\n\n

\n","urlObject":{"protocol":"https","path":["getallproducts"],"host":["tradeembroidery","com"],"query":[{"key":"token","value":"4788-ae540d-23ad98-d19326-f27ae0375b019adcaaaf5f8f0460df3d73"},{"key":"offset","value":"0"},{"key":"limit","value":"20"}],"variable":[]}},"response":[],"_postman_id":"fdbb630d-75ea-4aaf-91c0-adec7234a495"},{"name":"Get Specific Product API","id":"1695175f-6d67-4261-99ad-5a5017ac410a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://tradeembroidery.com/getspecificproduct?token=4788-ae540d-23ad98-d19326-f27ae0375b019adcaaaf5f8f0460df3d73&id=113","description":"

This API endpoint makes an HTTP GET request to retrieve specific product details using the provided token and product ID. The request should include the token and ID as query parameters in the URL.

The response to the request will have a status code of 200, and it will contain a JSON object with a \"response_code\", \"data\", and \"status\" keys. The \"data\" key holds an array of product details, including the product ID, name, description, price, delivery details, category, size guide, attributes, and customizations.

The \"attributes\" key further contains information about the available colors and sizes or other applicable attributes for the product, while the \"customizations\" key provides details about the customizable aspects of the product such as position, type, and artwork. Both the attrbites and customisations are required under post request for Place Order API.

Please note that the response may contain empty strings for some of the fields, which indicates that the corresponding information is not available.

\n","urlObject":{"protocol":"https","path":["getspecificproduct"],"host":["tradeembroidery","com"],"query":[{"key":"token","value":"4788-ae540d-23ad98-d19326-f27ae0375b019adcaaaf5f8f0460df3d73"},{"key":"id","value":"113"}],"variable":[]}},"response":[],"_postman_id":"1695175f-6d67-4261-99ad-5a5017ac410a"},{"name":"Place Order API","id":"e69816e7-b14b-4bf9-991e-b31fd31534d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"token","value":"f16a-3567c-a6d1b-b2421-b576ad244d18140a1cb970e4125ca053645e0","type":"text"},{"key":"order","value":"[\n {\n \"delivery_address\": {\n \"firstName\": \"Germane\",\n \"lastName\": \"Pierce\",\n \"company\": \"UBC\",\n \"addressLine1\": \"23 Deedham Drive\",\n \"addressLine2\": \"\",\n \"city\": \"San Jose\",\n \"county\": \"CA\",\n \"postalCode\": \"90001\",\n \"mobile\": \"\"\n },\n \"order_notes\": \"Here comes my text for Order note\",\n \"order_reference\": \"Here comes the reference for order\",\n \"products\": [{\n \"productid\": 2458,\n \"attributes\":{ \n \"Colour\": \"Black\",\n \"Size\": \"S\",\n \"Quantity\": 1\n },\n \"customisations\": {\n \"Position\": \"Front Left\",\n \"Type\": \"Print\",\n \"Artwork\": \"Logo\"\n },\n \"customisation_text\": \"My Logo\"\n }]\n }\n]","type":"text"},{"key":"artwork_2458","type":"file","value":null}]},"url":"https://tradeembroidery.com/placeorder","description":"

This endpoint is used to place an order. The request should be sent as an HTTP POST to the specified URL. Please check the sample example request with and without Colour and Size attributes. The request should include form-data with the following parameters:

token: (type: default) - The token for authentication.
order: (type: default) - The details of the order.
artwork_{product_id}: (type: file) - The artwork file for the order.

The response to the request will have a status code of 200 and will include the following fields:

response_code: The code indicating the response status.
message: A message related to the response.
status: The status of the response.

\n","urlObject":{"protocol":"https","path":["placeorder"],"host":["tradeembroidery","com"],"query":[],"variable":[]}},"response":[{"id":"df778948-b0c3-4e5f-8f95-6b86baa2c9e1","name":"Without Colour & Size attributes","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"bf47643c-5d6f-4333-9d44-8c977f7dbf09","name":"With Colour & Size attributes","originalRequest":{"method":"GET","header":[]},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e69816e7-b14b-4bf9-991e-b31fd31534d1"},{"name":"Get Product Price API","id":"afc816c0-d51b-4465-9efa-b32eff39ae89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"token","value":"4788-ae540d-23ad98-d19326-f27ae0375b019adcaaaf5f8f0460df3d73","type":"text","uuid":"50d79a30-c44c-48ec-8b9e-9663fa1f83b3"},{"key":"id","value":"113","type":"text","uuid":"4c04f44e-3a3c-458a-9217-d9040d6628eb"},{"key":"attributes","value":"{\"Colour\": \"Stone Blue\",\"Size\": \"M\",\"Quantity\":1}","type":"text","uuid":"30fd80a0-1366-4f48-ba75-4669b6b4a25c"},{"key":"customisations","value":"{\n \"Position\": \"Front Left\",\n \"Type\": \"Print\",\n \"Artwork\": \"Logo\"\n}","type":"text","uuid":"a8951908-c86e-4f41-864c-1eea79301785"}]},"url":"https://tradeembroidery.com/getproductprice","urlObject":{"protocol":"https","path":["getproductprice"],"host":["tradeembroidery","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"afc816c0-d51b-4465-9efa-b32eff39ae89"}]}