{ "info": { "_postman_id": "da49a590-f0a9-458d-900c-df8e9876f18f", "name": "Gooten API", "description": "API for Gooten Print-on-Demand services", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "44495251" }, "item": [ { "name": "Products", "item": [ { "name": "Get User Location", "request": { "method": "GET", "header": [], "url": { "raw": "{{geoBaseUrl}}/ip", "host": [ "{{geoBaseUrl}}" ], "path": [ "ip" ] }, "description": "Retrieves location information based on the user's IP address" }, "response": [ { "name": "User location information retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/ip/", "host": [ "{{baseUrl}}" ], "path": [ "ip", "" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "US" } ] }, { "name": "Get Supported Shipping Countries", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/countries/?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "countries", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Retrieves a list of countries supported for shipping" }, "response": [ { "name": "List of supported countries retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/countries/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "countries", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Countries\": [\n {\n \"Name\": \"United States\",\n \"Code\": \"US\",\n \"IsSupported\": true,\n \"MeasurementCode\": \"INCH\",\n \"FlagUrl\": \"http://test.com/US.png\",\n \"DefaultCurrency\": {\n \"Name\": \"United States dollar\",\n \"Code\": \"USD\",\n \"Format\": \"${1}\"\n }\n }\n ]\n}" } ] }, { "name": "List of Products", "request": { "method": "GET", "header": [], "url": { "raw": "{{cdnBaseUrl}}/productdatav3/catalog.json", "host": [ "{{cdnBaseUrl}}" ], "path": [ "productdatav3", "catalog.json" ] }, "description": "Retrieves the catalog of available products" }, "response": [ { "name": "Product catalog retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/productdatav3/catalog.json", "host": [ "{{baseUrl}}" ], "path": [ "productdatav3", "catalog.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"product-catalog\": [\n {\n \"name\": \"Bestsellers\",\n \"type\": \"category\",\n \"meta_title\": \"Trending Dropshipping Products | Gooten\",\n \"meta_description\": \"Browse Gooten's collection of the trending print on demand products for eCommerce businesses, including apparel, decor & more. Get inspired - create your business own here.\",\n \"description\": \"Our trending products ready for your custom designs and images\",\n \"items\": [\n {\n \"vendor_routing\": \"|14;*\",\n \"product_id\": 352,\n \"meta_description\": \"Our exclusive collection of woven pillows is expertly crafted to bring comfort and elegance to your living space. These decorative pillows are made from a carefully woven blend of 58% cotton and 42% polyester yarns, ensuring a cozy and luxurious feel. With their double-sided design and tapestry fabric, they offer versatility and style, perfect for enhancing any room's ambiance. Each pillow is filled with high-quality poly fill and securely sewn closed. The finer yarn count and tight weaving of the threads beautifully captures the most intricate designs, making this customizable woven pillow a cherished piece of home decor. Make sure to check our throw pillows and woven blankets that could be a great addition for your on demand store collection.\",\n \"url\": \"https://appassets.azureedge.net/product-throwpillows/Preview/Latest/Pillow_Woven_Catalog_Photo_01.png\",\n \"name\": \"Woven Pillows\",\n \"meta_title\": \"Print On Demand Woven Pillows | Gooten\",\n \"cheapest_shipping\": \"$9.49\",\n \"deprecated\": false,\n \"cheapest_price\": \"$22.40\",\n \"out_of_stock\": false,\n \"type\": \"product\",\n \"staging_product_id\": 1351\n }\n ]\n }\n ]\n}" } ] }, { "name": "List of Product Variants", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/productvariants/?recipeid={{recipeId}}&countryCode=&productId=&version=&source=¤cyCode=&compression=&page=&pageSize=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "productvariants", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "countryCode", "value": "", "description": "(Required) Country code for shipping" }, { "key": "productId", "value": "", "description": "(Required) ID of the product" }, { "key": "version", "value": "", "description": "API version" }, { "key": "source", "value": "", "description": "Source of the request" }, { "key": "currencyCode", "value": "", "description": "Currency code for pricing" }, { "key": "compression", "value": "", "description": "Whether to compress the response" }, { "key": "page", "value": "", "description": "Page number for pagination" }, { "key": "pageSize", "value": "", "description": "Number of items per page" } ] }, "description": "Retrieves variants available for a specific product" }, "response": [ { "name": "Product variants retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/productvariants/?recipeid=&countryCode=&productId=&version=&source=¤cyCode=&compression=&page=&pageSize=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "productvariants", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "countryCode", "value": "", "description": "(Required) Country code for shipping" }, { "key": "productId", "value": "", "description": "(Required) ID of the product" }, { "key": "version", "value": "", "description": "API version" }, { "key": "source", "value": "", "description": "Source of the request" }, { "key": "currencyCode", "value": "", "description": "Currency code for pricing" }, { "key": "compression", "value": "", "description": "Whether to compress the response" }, { "key": "page", "value": "", "description": "Page number for pagination" }, { "key": "pageSize", "value": "", "description": "Number of items per page" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"ProductVariants\": [\n {\n \"Sku\": \"string\",\n \"MaxImages\": \"integer\",\n \"HasTemplates\": \"boolean\",\n \"Options\": [\n {\n \"OptionId\": \"string\",\n \"ValueId\": \"string\",\n \"Name\": \"string\",\n \"Value\": \"string\",\n \"ImageUrl\": \"string\",\n \"ImageType\": \"string\",\n \"RgbaColor\": \"string\",\n \"CmValue\": \"string\",\n \"SortValue\": \"string\"\n }\n ],\n \"PriceInfo\": \"PriceInfo\",\n \"PartnerPriceInfo\": \"PriceInfo\"\n }\n ],\n \"Options\": [\n {\n \"Name\": \"string\",\n \"Values\": [\n {\n \"OptionId\": \"string\",\n \"ValueId\": \"string\",\n \"Name\": \"string\",\n \"Value\": \"string\",\n \"ImageUrl\": \"string\",\n \"ImageType\": \"string\",\n \"RgbaColor\": \"string\",\n \"CmValue\": \"string\",\n \"SortValue\": \"string\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "Check Stock Availability per SKU", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Skus\": [\n \"\",\n \"\"\n ],\n \"CountryCode\": \"\",\n \"State\": \"\",\n \"PostalCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/variantstatus?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "variantstatus" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Checks the availability status of product variants" }, "response": [ { "name": "Stock availability retrieved successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Skus\": [\n \"Apparel-Sublimation-Sweatshirt-M-AOP\",\n \"Apparel-DTG-TShirt-TSC-2168-L-Natural-Unisex-CF\",\n \"Apparel-DTG-Hanes-TShirt-5180-M-DeepForest-Mens-CF\",\n \"Apparel-DTG-Tshirt-Gildan-5000-2XL-Black-Mens-CF\"],\n \"CountryCode\": \"US\",\n \"State\": \"NY\",\n \"PostalCode\": \"10019\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/variantstatus?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "variantstatus" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "[\n \"Apparel-Sublimation-Sweatshirt-M-AOP\",\n \"apparel-dtg-hanes-tshirt-5180-m-deepforest-mens-cf\"\n]" } ] }, { "name": "List of Product Templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/producttemplates/?recipeid={{recipeId}}&sku=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "producttemplates", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "sku", "value": "", "description": "(Required) SKU of the product" } ] }, "description": "Retrieves templates available for a specific product" }, "response": [ { "name": "Product templates retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/producttemplates/?recipeid=&sku=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "producttemplates", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "sku", "value": "", "description": "(Required) SKU of the product" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"Options\": [\r\n {\r\n \"DPI\": 300,\r\n \"Format\": \"png\",\r\n \"Name\": \"Single\",\r\n \"ImageUrl\": \"https://az412349.vo.msecnd.net:443/product-phonecases/Preview/iPhone12/IP12-SnapCase-Preview.png\",\r\n \"IsDefault\": true,\r\n \"IsArchived\": true,\r\n \"ArchivedReason\": 2,\r\n \"Spaces\": [\r\n {\r\n \"Id\": \"63AD0\",\r\n \"Index\": 1,\r\n \"DefaultRotation\": 0,\r\n \"Description\": \"Default\",\r\n \"Layers\": [\r\n {\r\n \"Id\": \"57EA9\",\r\n \"Type\": \"Design\",\r\n \"ZIndex\": 0,\r\n \"X1\": 0,\r\n \"X2\": 1205,\r\n \"Y1\": 0,\r\n \"Y2\": 2020,\r\n \"BackgroundImageUrl\": \"https://az412349.cdn.gooten.com/product-phonecases/Backgrounds/iPhone-12/iPhone-12-SnapCase-Background.png\",\r\n \"IncludeInPrint\": false\r\n },\r\n {\r\n \"Id\": \"EAA4C\",\r\n \"Description\": \"image_specs\",\r\n \"Type\": \"Image\",\r\n \"ZIndex\": 1,\r\n \"X1\": 0,\r\n \"X2\": 1205,\r\n \"Y1\": 0,\r\n \"Y2\": 2020,\r\n \"Positioning\": \"CenterCenter\",\r\n \"IncludeInPrint\": true\r\n },\r\n {\r\n \"Id\": \"242F4\",\r\n \"Description\": \"mask\",\r\n \"Type\": \"Design\",\r\n \"ZIndex\": 2,\r\n \"X1\": 0,\r\n \"X2\": 1205,\r\n \"Y1\": 0,\r\n \"Y2\": 2020,\r\n \"OverlayImageUrl\": \"https://az412349.cdn.gooten.com/product-phonecases/Masks/iPhone-12/iPhone-12-SnapCase-Mask.png\",\r\n \"IncludeInPrint\": false\r\n },\r\n {\r\n \"Id\": \"E803E\",\r\n \"Description\": \"overlay\",\r\n \"Type\": \"Design\",\r\n \"ZIndex\": 3,\r\n \"X1\": 0,\r\n \"X2\": 1205,\r\n \"Y1\": 0,\r\n \"Y2\": 2020,\r\n \"OverlayImageUrl\": \"https://az412349.cdn.gooten.com:443/product-phonecases/Overlays/iPhone-12/iPhone-12-SnapCase-Overlay.png\",\r\n \"IncludeInPrint\": false\r\n },\r\n {\r\n \"Id\": \"FC06D\",\r\n \"Type\": \"Bleed\",\r\n \"ZIndex\": 4,\r\n \"X1\": 0,\r\n \"X2\": 1205,\r\n \"Y1\": 0,\r\n \"Y2\": 2020,\r\n \"BleedImageUrl\": \"https://az412349.cdn.gooten.com/product-phonecases/Bleeds/iPhone-12/iPhone-12-SnapCase-Bleed.png\",\r\n \"IncludeInPrint\": false\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}" } ] }, { "name": "Print Ready Products - List", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/prpproducts/?recipeid={{recipeId}}&page=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "prpproducts", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "page", "value": "", "description": "Page number" } ] }, "description": "Retrieves a list of preconfigured products (PRPs)" }, "response": [ { "name": "PRP products retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/prpproducts/?recipeid=&page=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "prpproducts", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "page", "value": "", "description": "Page number" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"PageCount\": 5,\n \"Page\": 1,\n \"Products\": [\n {\n \"ProductName\": \"000-AKOO\",\n \"NumberOfVariants\": 1\n }\n ],\n \"HadError\": false\n}" } ] }, { "name": "Print Ready Products - Create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Sku\": \"\",\n \"Name\": \"\",\n \"Items\": [\n {\n \"ProductId\": \"\",\n \"ProductVariantSku\": \"\",\n \"TemplateName\": \"\",\n \"Preconfigurations\": [\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n },\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n }\n ]\n },\n {\n \"ProductId\": \"\",\n \"ProductVariantSku\": \"\",\n \"TemplateName\": \"\",\n \"Preconfigurations\": [\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n },\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n }\n ]\n }\n ],\n \"Description\": \"\",\n \"Images\": [\n {\n \"Url\": \"\",\n \"Index\": \"\",\n \"Id\": \"\"\n },\n {\n \"Url\": \"\",\n \"Index\": \"\",\n \"Id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/preconfiguredproducts/?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "preconfiguredproducts", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID for the order" } ] }, "description": "Creates a new preconfigured product (PRP)" }, "response": [ { "name": "PRP Product successfully created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Sku\": \"Tshirt-M-WhiteNeonPink-Unisex\",\n \"Name\": \"Apparel\",\n \"Description\": \"Apparel\",\n \"Items\": [\n {\n \"ProductId\": 1196,\n \"ProductVariantSku\": \"Apparel-DTG-Tshirt-Bella-3200-M-WhiteNeonPink-Unisex-CFCB\",\n \"TemplateName\": \"Single\",\n \"Preconfigurations\": [\n {\n \"SpaceId\": \"8D3FF\",\n \"Url\": \"https://appassets.azureedge.net/temp/acd68e92-6042-45a4-bbe4-b1fb99b522ce-8E5FD62F-6E00-4C85-B5C4-D258AD397B83.png\"\n },\n {\n \"SpaceId\": \"6A38D\",\n \"Url\": \"https://appassets.azureedge.net/temp/d2c5f5e6-ca55-4cc4-a376-b8d4bafa0c02-353A2EE1-DE36-4E7B-963F-B6D17257A2F5.png\"\n }\n ]\n }\n ],\n \"Images\": [\n {\n \"Url\": \"https://appassets.azureedge.net/temp/acd68e92-6042-45a4-bbe4-b1fb99b522ce-8E5FD62F-6E00-4C85-B5C4-D258AD397B83.png\",\n \"Index\": 0\n },\n {\n \"Url\": \"https://appassets.azureedge.net/temp/d2c5f5e6-ca55-4cc4-a376-b8d4bafa0c02-353A2EE1-DE36-4E7B-963F-B6D17257A2F5.png\",\n \"Index\": 1\n },\n {\n \"Url\": \"https://gtn-imgmanip-v2-cdn.azureedge.net/staging/preview/40e7d704-6847-4180-9fb6-dfbd1b1ee696/008c135db8da0cfb21f3ae00ab76309d.png\",\n \"Id\": \"generated-preview\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/preconfiguredproducts/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "preconfiguredproducts", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID for the order" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Print Ready Products - Update", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Sku\": \"\",\n \"Name\": \"\",\n \"Items\": [\n {\n \"ProductId\": \"\",\n \"ProductVariantSku\": \"\",\n \"TemplateName\": \"\",\n \"Preconfigurations\": [\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n },\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n }\n ]\n },\n {\n \"ProductId\": \"\",\n \"ProductVariantSku\": \"\",\n \"TemplateName\": \"\",\n \"Preconfigurations\": [\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n },\n {\n \"SpaceDesc\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n }\n ]\n }\n ],\n \"Description\": \"\",\n \"Images\": [\n {\n \"Url\": \"\",\n \"Index\": \"\",\n \"Id\": \"\"\n },\n {\n \"Url\": \"\",\n \"Index\": \"\",\n \"Id\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/preconfiguredproducts/?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "preconfiguredproducts", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Updates an existing preconfigured product (PRP)" }, "response": [ { "name": "PRP Product successfully updated", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Sku\": \"Tshirt-M-WhiteNeonPink-Unisex\",\n \"Name\": \"Apparel\",\n \"Description\": \"Updated Apparel\",\n \"Items\": [\n {\n \"ProductId\": 1196,\n \"ProductVariantSku\": \"Apparel-DTG-Tshirt-Bella-3200-XL-WhiteNeonPink-Unisex-CB\",\n \"TemplateName\": \"Single\",\n \"Preconfigurations\": [\n {\n \"SpaceId\": \"30CE4\",\n \"Url\": \"https://appassets.azureedge.net/temp/acd68e92-6042-45a4-bbe4-b1fb99b522ce-8E5FD62F-6E00-4C85-B5C4-D258AD397B83.png\"\n }\n ]\n }\n ],\n \"Images\": [\n {\n \"Url\": \"https://appassets.azureedge.net/temp/acd68e92-6042-45a4-bbe4-b1fb99b522ce-8E5FD62F-6E00-4C85-B5C4-D258AD397B83.png\",\n \"Index\": 0\n },\n {\n \"Url\": \"https://s3.amazonaws.com/gooten-imgmanip-temp/staging/preview/40e7d704-6847-4180-9fb6-dfbd1b1ee696/2f41962b360fbabe82dfbcd7d1fbf6ad.png\",\n \"Id\": \"generated-preview\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/preconfiguredproducts/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "preconfiguredproducts", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Print Ready Products - Delete", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/preconfiguredproducts/?recipeid={{recipeId}}&sku=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "preconfiguredproducts", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID for the order" }, { "key": "sku", "value": "", "description": "(Required) SKU of the PRP product to delete" } ] }, "description": "Deletes an existing preconfigured product (PRP)" }, "response": [ { "name": "PRP Product successfully deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/preconfiguredproducts/?recipeid=&sku=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "preconfiguredproducts", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID for the order" }, { "key": "sku", "value": "", "description": "(Required) SKU of the PRP product to delete" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Print Ready Products - List Variants", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/prpvariants/?recipeid={{recipeId}}&page=&productName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "prpvariants", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "page", "value": "", "description": "Page number for pagination" }, { "key": "productName", "value": "", "description": "Filter by product name" } ] }, "description": "Retrieves variants of preconfigured products (PRPs)" }, "response": [ { "name": "PRP variants retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/prpvariants/?recipeid=&page=&productName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "prpvariants", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "page", "value": "", "description": "Page number for pagination" }, { "key": "productName", "value": "", "description": "Filter by product name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"PageCount\": 1,\n \"Page\": 1,\n \"Variants\": [],\n \"HadError\": false\n}" } ] }, { "name": "PRO Product Previews - Get a list of all available templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{previewsBaseUrl}}/api/v/2/templates?recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "templates" ], "query": [ { "key": "recipeId", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] } }, "response": [ { "name": "Templates retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{previewsBaseUrl}}/api/v/2/templates?recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "templates" ], "query": [ { "key": "recipeId", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"templates\": [\r\n {\r\n \"style\": \"Studio-Minimal\",\r\n \"name\": \"Accent-Mug-Black-Studio-Minimal-Right\",\r\n \"background\": \"https://test.com/img.jpg\",\r\n \"width\": 2333,\r\n \"height\": 2446,\r\n \"angle\": \"Right\",\r\n \"areas\": [\r\n {\r\n \"sku\": \"Mug11oz-White-BlackAccent\",\r\n \"width\": 2538,\r\n \"height\": 945,\r\n \"layerId\": \"6C9AC\",\r\n \"spaceId\": \"AADC6\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"error\": false\r\n}" } ] }, { "name": "PRO Product Previews - Get a list of available templates for a specific SKU", "request": { "method": "GET", "header": [], "url": { "raw": "{{previewsBaseUrl}}/api/v/2/templates/for-sku/{{skuName}}?recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}&strict=true", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "templates", "for-sku", "{{skuName}}" ], "query": [ { "key": "recipeId", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" }, { "key": "strict", "value": "true" } ] } }, "response": [ { "name": "Templates retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{previewsBaseUrl}}/api/v/2/templates/for-sku/{{skuName}}?recipeId=&partnerBillingKey=&strict=true", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "templates", "for-sku", "{{skuName}}" ], "query": [ { "key": "recipeId", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" }, { "key": "strict", "value": "true" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"templates\": [\n {\n \"style\": \"Studio-Minimal\",\n \"name\": \"Accent-Mug-Blue-Studio-Minimal-Right\",\n \"background\": \"https://s3.amazonaws.com/ppml-data/data set/inpainting_results/Mug11oz-White-BlueAccent_Simple_Right.jpg\",\n \"width\": 2761,\n \"height\": 2761,\n \"angle\": \"Right\",\n \"areas\": [\n {\n \"sku\": \"Mug11oz-White-BlueAccent\",\n \"width\": 2538,\n \"layerId\": \"6C9AC\",\n \"spaceId\": \"C014E\",\n \"height\": 945\n }\n ]\n },\n {\n \"style\": \"Studio-Minimal\",\n \"name\": \"TravelBag-Large-Studio-Minimal-Top\",\n \"background\": \"https://s3.amazonaws.com/ppml-data/data set/inpainting_results/travelbag-3_whiteout.jpg\",\n \"width\": 4860,\n \"height\": 4860,\n \"angle\": \"Top\",\n \"areas\": [\n {\n \"sku\": \"TravelBag-Large\",\n \"width\": 2783,\n \"layerId\": \"B82BCF\",\n \"spaceId\": \"0BBFE\",\n \"height\": 2036\n },\n {\n \"sku\": \"TravelBag-Large\",\n \"width\": 1321,\n \"layerId\": \"22F2ED\",\n \"spaceId\": \"FFD03\",\n \"height\": 1577\n },\n {\n \"sku\": \"TravelBag-Large\",\n \"width\": 1321,\n \"layerId\": \"522F2\",\n \"spaceId\": \"BDFDC\",\n \"height\": 1577\n },\n {\n \"sku\": \"TravelBag-Large\",\n \"width\": 2783,\n \"layerId\": \"DB82B\",\n \"spaceId\": \"9E472\",\n \"height\": 2036\n }\n ]\n }\n ]\n}" } ] }, { "name": "PRO Product Previews - Generate Pro Preview", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"template\": \"\",\r\n \"areas\": [\r\n {\r\n \"url\": \"\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{previewsBaseUrl}}/api/v/2/generate?recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "generate" ], "query": [ { "key": "recipeId", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] } }, "response": [ { "name": "Pro Preview generated successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"template\": \"Accent-Mugs-Center-Angular-Black\",\r\n \"areas\": [\r\n {\r\n \"url\": \"https://www.fillmurray.com/g/2538/945\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{previewsBaseUrl}}/api/v/2/generate?recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "generate" ], "query": [ { "key": "recipeId", "value": "{{recipeId}}" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"error\": false,\n \"url\": \"https://gtnimgmanipcdn.azureedge.net/img manip/201808152049554753399717974446819.jpg\"\n}" }, { "name": "Pro Preview generated successfully for Multi-Area Products", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"template\": \"TravelBag-Large-Studio-Minimal-Front\",\r\n \"areas\": [\r\n {\r\n \"layerId\": \"22F2ED\",\r\n \"spaceId\": \"FFD03\",\r\n \"url\": \"https://www.fillmurray.com/1321/1577\"\r\n },\r\n {\r\n \"layerId\": \"DB82B\",\r\n \"spaceId\": \"9E472\",\r\n \"url\": \"https://www.fillmurray.com/2783/2036\"\r\n },\r\n {\r\n \"layerId\": \"522F2\",\r\n \"spaceId\": \"BDFDC\",\r\n \"url\": \"https://www.fillmurray.com/2783/2036\"\r\n },\r\n {\r\n \"layerId\": \"B82BCF\",\r\n \"spaceId\": \"0BBFE\",\r\n \"url\": \"https://www.fillmurray.com/1321/1577\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{previewsBaseUrl}}/api/v/2/generate?recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{previewsBaseUrl}}" ], "path": [ "api", "v", "2", "generate" ], "query": [ { "key": "recipeId", "value": "{{recipeId}}" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"error\": false,\n \"url\": \"https://gtnimgmanipcdn.azureedge.net/img manip/201808152049554753399717974446819.jpg\"\n}" } ] }, { "name": "Simple Product Previews - Generate Preview", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"SKU\": \"\",\n \"Template\": \"\",\n \"Images\": [\n {\n \"Image\": {\n \"Url\": \"\",\n \"MaxFit\": \"\",\n \"X1\": \"\",\n \"X2\": \"\",\n \"Y1\": \"\",\n \"Y2\": \"\"\n }\n },\n {\n \"Image\": {\n \"Url\": \"\",\n \"MaxFit\": \"\",\n \"X1\": \"\",\n \"X2\": \"\",\n \"Y1\": \"\",\n \"Y2\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/productpreview/?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "productpreview", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Generates a preview image for a product" }, "response": [ { "name": "Product preview generated successfully for Single Print Space SKU", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"SKU\": \"FramedCanvs-5x7-Black\",\n \"Template\": \"Single\",\n \"Images\": [\n {\n \"Image\": {\n \"Url\": \"https://d3d6kbc7r9kabj.cloudfront.net/widget-live/30728_B_-72ff391a3aa24f23be8dca32a2e6822a.jpg\",\n \"MaxFit\": \"true\",\n \"X1\": 677,\n \"X2\": 3152,\n \"Y1\": 72,\n \"Y2\": 1227\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/productpreview/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "productpreview", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Images\": [\n {\n \"Url\": \"https://s3.amazonaws.com/gooten-imgmanip/live/preview/f255af6f-9614-4fe2-aa8b-1b77b936d9d6/e46051eb2c95fc06f0a3e31e5b3d15c8.png\",\n \"SpaceId\": \"58017\"\n }\n ],\n \"HadError\": false\n}" }, { "name": "Product preview generated successfully for Multi Print Space SKU", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"SKU\": \"Apparel-DTG-TShirt-Bella-6400-M-BlackHeather-Womens-CFCB\",\n \"Template\": \"Single\",\n \"Images\": [\n {\n \"Image\": {\n \"Url\": \"https://d3d6kbc7r9kabj.cloudfront.net/widget-live/8E5FD62F-6E00-4C85-B5C4-D258AD397B83.jpeg\"\n },\n \"SpaceId\": \"96D93\",\n \"LayerId\": \"64B0D\"\n },\n {\n \"Image\": {\n \"Url\": \"https://d3d6kbc7r9kabj.cloudfront.net/widget-live/353A2EE1-DE36-4E7B-963F-B6D17257A2F5.png\"\n },\n \"SpaceId\": \"4887A\",\n \"LayerId\": \"55E07\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/productpreview/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "productpreview", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Images\": [\n {\n \"Url\": \"https://gtn-imgmanip-v2-cdn.azureedge.net/live/preview/f255af6f-9614-4fe2-aa8b-1b77b936d9d6/3a09c33a54dac829eac0d62e7dd93bc7.png\",\n \"SpaceId\": \"96D93\"\n },\n {\n \"Url\": \"https://gtn-imgmanip-v2-cdn.azureedge.net/live/preview/f255af6f-9614-4fe2-aa8b-1b77b936d9d6/adccab00edb3efa82d88cc97dd7d7282.png\",\n \"SpaceId\": \"4887A\"\n }\n ],\n \"HadError\": false\n}" } ] } ] }, { "name": "Orders", "item": [ { "name": "Cancel an order item in your order", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/orderCancel?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orderCancel" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Cancels specific items in an existing order" }, "response": [ { "name": "Items successfully canceled", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/orderCancel?orderId=&recipeid=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "orderCancel" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "" }, { "key": "partnerBillingKey", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": \"boolean\",\n \"Errors\": [\n {\n \"PropertyName\": \"string\",\n \"ErrorMessage\": \"string\"\n }\n ],\n \"Success\": [\n {\n \"ItemId\": \"integer\",\n \"StatusId\": \"integer\"\n }\n ]\n}" } ] }, { "name": "Get Orders by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/orders/?recipeid={{recipeId}}&id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "orders", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID for the order" }, { "key": "id", "value": "", "description": "(Required) Safe Order ID to retrieve" } ] }, "description": "Retrieves order information by order ID" }, "response": [ { "name": "Order details retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/orders/?recipeid=&id=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "orders", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID for the order" }, { "key": "id", "value": "", "description": "(Required) Order ID to retrieve" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Id\": \"string\",\n \"NiceId\": \"string\",\n \"SourceId\": \"string\",\n \"GootenId\": \"integer\",\n \"Items\": [\n {\n \"Sku\": \"string\",\n \"ProductId\": \"integer\",\n \"Product\": \"string\",\n \"Quantity\": \"integer\",\n \"Status\": \"string\",\n \"TrackingNumber\": \"string\",\n \"TrackingUrl\": \"string\",\n \"ShipCarrierName\": \"string\",\n \"OrderId\": \"integer\",\n \"OrderItemId\": \"integer\",\n \"SourceId\": \"string\",\n \"Price\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"DiscountAmount\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"MetaJson\": \"string\",\n \"Meta\": {\n \"key1\": \"string\",\n \"key2\": \"string\"\n },\n \"Shipments\": [\n {\n \"TrackingNumber\": \"string\",\n \"TrackingUrl\": \"string\",\n \"ShipCarrierName\": \"string\"\n }\n ],\n \"Images\": [\n {\n \"RecipeImageId\": \"integer\",\n \"SourceUrl\": \"string\",\n \"SpaceId\": \"string\",\n \"SpaceDesc\": \"string\",\n \"ThumbnailUrl\": \"string\",\n \"OrderItemId\": \"integer\"\n }\n ],\n \"Options\": [\n {\n \"ProductOptionId\": \"string\",\n \"ProductOptionValueId\": \"string\",\n \"Name\": \"string\",\n \"Value\": \"string\",\n \"SortValue\": \"string\"\n }\n ],\n \"IsReOrderable\": true\n }\n ],\n \"Total\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"ShippingTotal\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"ShippingAddress\": {\n \"FirstName\": \"string\",\n \"LastName\": \"string\",\n \"Line1\": \"string\",\n \"Line2\": \"string\",\n \"City\": \"string\",\n \"State\": \"string\",\n \"CountryCode\": \"string\",\n \"PostalCode\": \"string\",\n \"Phone\": \"string\",\n \"Email\": \"string\"\n },\n \"BillingAddress\": {\n \"FirstName\": \"string\",\n \"LastName\": \"string\",\n \"Line1\": \"string\",\n \"Line2\": \"string\",\n \"City\": \"string\",\n \"State\": \"string\",\n \"CountryCode\": \"string\",\n \"PostalCode\": \"string\",\n \"Phone\": \"string\",\n \"Email\": \"string\"\n },\n \"DiscountCode\": \"string\",\n \"DiscountAmount\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"Meta\": {\n \"key1\": \"string\",\n \"key2\": \"string\"\n }\n}" } ] }, { "name": "Get the billing information for an order", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/orderbilling?orderid=&recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "orderbilling" ], "query": [ { "key": "orderid", "value": "" }, { "key": "recipeId", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Retrieves billing information for an order" }, "response": [ { "name": "Order billing information retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/orderbilling?orderid=&recipeId=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "orderbilling" ], "query": [ { "key": "orderid", "value": "" }, { "key": "recipeId", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": false,\n \"Result\": {\n \"OrderSubtotal\": {\n \"Price\": 21.56,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$21.56\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"ShippingCost\": {\n \"Price\": 13.48,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$13.48\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"Surcharge\": {\n \"Price\": 0,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$0.00\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"Tax\": {\n \"Price\": 3.57,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$3.57\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"Discount\": {\n \"Price\": 0,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$0.00\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"Fees\": {\n \"Price\": 0,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$0.00\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"Total\": {\n \"Price\": 38.61,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$38.61\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"Items\": [\n {\n \"Id\": 1065621,\n \"ProductCost\": {\n \"Price\": 20.9,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$20.90\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"ShippingCost\": {\n \"Price\": 9.99,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$9.99\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n }\n },\n {\n \"Id\": 1065622,\n \"ProductCost\": {\n \"Price\": 0.66,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$0.66\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n },\n \"ShippingCost\": {\n \"Price\": 3.49,\n \"CurrencyCode\": \"USD\",\n \"FormattedPrice\": \"$3.49\",\n \"CurrencyFormat\": \"${1}\",\n \"CurrencyDigits\": 2\n }\n }\n ]\n }\n}" } ] }, { "name": "Search Orders", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/ordersearch?genericValues=&startDate=&endDate=&pageSize=&page=&recipeId={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "ordersearch" ], "query": [ { "key": "genericValues", "value": "", "description": "Search term for generic fields" }, { "key": "startDate", "value": "", "description": "Start date for order search (YYYY-MM-DD)" }, { "key": "endDate", "value": "", "description": "End date for order search (YYYY-MM-DD)" }, { "key": "pageSize", "value": "", "description": "Number of results per page" }, { "key": "page", "value": "", "description": "Page number for pagination" }, { "key": "recipeId", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Searches for orders based on various criteria" }, "response": [ { "name": "Search results retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/ordersearch/?genericValues=&startDate=&endDate=&pageSize=&page=&recipeId=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "ordersearch", "" ], "query": [ { "key": "genericValues", "value": "", "description": "Search term for generic fields" }, { "key": "startDate", "value": "", "description": "Start date for order search (YYYY-MM-DD)" }, { "key": "endDate", "value": "", "description": "End date for order search (YYYY-MM-DD)" }, { "key": "pageSize", "value": "", "description": "Number of results per page" }, { "key": "page", "value": "", "description": "Page number for pagination" }, { "key": "recipeId", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Orders\": [\n {\n \"Id\": \"string\",\n \"NiceId\": \"string\",\n \"SourceId\": \"string\",\n \"Items\": [\n {\n \"Sku\": \"string\",\n \"ProductId\": \"integer\",\n \"Product\": \"string\",\n \"Quantity\": \"integer\",\n \"Status\": \"string\",\n \"TrackingNumber\": \"string\",\n \"TrackingUrl\": \"string\",\n \"ShipCarrierName\": \"string\",\n \"Price\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"DiscountAmount\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"SourceId\": \"string\",\n \"Meta\": {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n },\n \"Shipments\": [\n {\n \"TrackingNumber\": \"string\",\n \"TrackingUrl\": \"string\",\n \"ShipCarrierName\": \"string\"\n }\n ]\n }\n ],\n \"Total\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"ShippingTotal\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"ShippingAddress\": \"Address\",\n \"BillingAddress\": \"Address\",\n \"DiscountCode\": \"string\",\n \"DiscountAmount\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"Meta\": {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n }\n ],\n \"TotalPages\": \"integer\",\n \"Page\": \"integer\",\n \"HadError\": \"boolean\"\n}" } ] }, { "name": "Submit an Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ShipToAddress\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Line1\": \"\",\n \"Line2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"CountryCode\": \"\",\n \"PostalCode\": \"\",\n \"IsBusinessAddress\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\"\n },\n \"Items\": [\n {\n \"Quantity\": \"\",\n \"SKU\": \"\",\n \"ShipType\": \"\",\n \"Images\": [\n {\n \"Url\": \"\"\n },\n {\n \"Url\": \"\"\n }\n ]\n },\n {\n \"Quantity\": \"\",\n \"SKU\": \"\",\n \"ShipType\": \"\",\n \"Images\": [\n {\n \"Url\": \"\"\n },\n {\n \"Url\": \"\"\n }\n ]\n }\n ],\n \"Payment\": {\n \"PartnerBillingKey\": \"\"\n },\n \"BillingAddress\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Line1\": \"\",\n \"Line2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"CountryCode\": \"\",\n \"PostalCode\": \"\",\n \"IsBusinessAddress\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\"\n },\n \"IsInTestMode\": \"\",\n \"Meta\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/orders/?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "orders", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Creates a new order" }, "response": [ { "name": "Order created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ShipToAddress\": {\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Line1\": \"79 Madison Ave\",\n \"Line2\": \"Suite 228\",\n \"City\": \"New York\",\n \"State\": \"NY\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"10016\",\n \"IsBusinessAddress\": false,\n \"Phone\": \"0000000000\",\n \"Email\": \"mail@test.com\"\n },\n \"BillingAddress\": {\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Line1\": \"79 Madison Ave\",\n \"Line2\": \"Suite 228\",\n \"City\": \"New York\",\n \"State\": \"NY\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"10016\",\n \"IsBusinessAddress\": false,\n \"Phone\": \"0000000000\",\n \"Email\": \"mail@test.com\"\n },\n \"Items\": [\n {\n \"Quantity\": 1,\n \"SKU\": \"Apparel-DTG-Tshirt-Anvil-980-M-LightBlue-Unisex-CFCB\",\n \"ShipType\": \"standard\",\n \"Images\": [\n {\n \"Url\": \"https://placekitten.com/3000/3000\"\n }\n ]\n }\n ],\n \"Payment\": {\n \"PartnerBillingKey\": \"oeO2j1ZbfU0TaDPRrhStEyp68ZRbXK8UfWfq7BKICGY=\"\n },\n \"IsInTestMode\": true,\n \"Meta\": {\n \"tag\": \"test order\",\n \"my value\": \"42\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/orders/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "orders", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Id\": \"string\"\n}" } ] }, { "name": "Submit an Embroidery Order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ShipToAddress\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Line1\": \"\",\n \"Line2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"CountryCode\": \"\",\n \"PostalCode\": \"\",\n \"IsBusinessAddress\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\"\n },\n \"SaveShippingAddress\": \"\",\n \"BillingAddress\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Line1\": \"\",\n \"Line2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"CountryCode\": \"\",\n \"PostalCode\": \"\",\n \"IsBusinessAddress\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\"\n },\n \"Items\": [\n {\n \"SKU\": \"\",\n \"Quantity\": \"\",\n \"Images\": [\n {\n \"Url\": \"\",\n \"UseUrlAsImageID\": \"\"\n }\n ],\n \"IsSample\": \"\",\n \"ShipCarrierMethodId\": \"\"\n }\n ],\n \"Payment\": {\n \"CurrencyCode\": \"\",\n \"PartnerBillingKey\": \"\"\n },\n \"IsPreSubmit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/orders?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Creates a new order" }, "response": [ { "name": "Order created successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ShipToAddress\": {\n \"FirstName\": \"Jhon\",\n \"LastName\": \"Doo\",\n \"Line1\": \"42 Street\",\n \"City\": \"TestCity\",\n \"State\": \"CA\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"12034\",\n \"Phone\": \"555-555-1212\",\n \"Email\": \"hi@email.com\"\n },\n \"SaveShippingAddress\": false,\n \"BillingAddress\": {\n \"FirstName\": \"Jhon\",\n \"LastName\": \"Doo\",\n \"Line1\": \"42 Street\",\n \"City\": \"TestCity\",\n \"State\": \"CA\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"12034\",\n \"Phone\": \"555-555-1212\",\n \"Email\": \"hi@email.com\"\n },\n \"Items\": [\n {\n \"SKU\": \"DadCaps-Embroidery-Black\",\n \"Quantity\": 1,\n \"Images\": [\n {\n \"Url\": \"image-url\", //The ImageURL that will be used for embroidery\n \"UseUrlAsImageID\": true //This flag approves the image URL used above to be used and saved for digitization.\n }\n ],\n \"IsSample\": false,\n \"AddOns\": null,\n \"ShipCarrierMethodId\": 1\n }\n ],\n \"Payment\": {\n \"CurrencyCode\": \"USD\",\n \"PartnerBillingKey\": \"YourPartnerBillingKey\"\n },\n \"IsPreSubmit\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/orders?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "orders" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "{\r\n \"Id\": \"115557-68eb0c64-bf4f-4e79-bf91-67772507ed78\"\r\n}" } ] }, { "name": "Update Order Status", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/orderstatus?recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}&id=&orderStatusName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "orderstatus" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" }, { "key": "id", "value": "", "description": "(Required) Order Safe ID to update" }, { "key": "orderStatusName", "value": "", "description": "(Required) New status for the order" } ] }, "description": "Updates the status of an existing order" }, "response": [ { "name": "Order status updated successfully", "originalRequest": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/orderstatus?recipeid=&partnerBillingKey=&id=&orderStatusName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "orderstatus" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" }, { "key": "id", "value": "", "description": "(Required) Order ID to update" }, { "key": "orderStatusName", "value": "", "description": "(Required) New status for the order" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": \"boolean\",\n \"Errors\": [\n {\n \"PropertyName\": \"string\",\n \"ErrorMessage\": \"string\"\n }\n ],\n \"Success\": [\n {\n \"ItemId\": \"integer\",\n \"StatusId\": \"integer\"\n }\n ]\n}" } ] }, { "name": "Update the Shipping Address", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Address\": {\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"Line1\": \"\",\n \"Line2\": \"\",\n \"City\": \"\",\n \"State\": \"\",\n \"CountryCode\": \"\",\n \"PostalCode\": \"\",\n \"Phone\": \"\",\n \"Email\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/shippingAddress?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "shippingAddress" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Updates the shipping address for an existing order" }, "response": [ { "name": "Shipping address updated successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Address\": {\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Line1\": \"123 Maple Street\",\n \"Line2\": \"Apt 4B\",\n \"City\": \"Springfield\",\n \"State\": \"IL\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"62704\",\n \"Phone\": \"+1-217-555-0123\",\n \"Email\": \"john.doe@example.com\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/shippingAddress?orderId=&recipeid=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "shippingAddress" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": false,\n \"Result\": {\n \"OldAddress\": {\n \"FirstName\": \"John\",\n \"LastName\": \"Doo\",\n \"Line1\": \"142 W 57TH ST Suite 10-111\",\n \"Line2\": \"10th Floor\",\n \"City\": \"NEW YORK\",\n \"State\": \"NY\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"10019-3300\",\n \"Phone\": \"555-55555555\",\n \"Email\": \"test@test.com\"\n },\n \"UpdatedAddress\": {\n \"FirstName\": \"John\",\n \"LastName\": \"Doo\",\n \"Line1\": \"142 W 57TH ST Suite 10-222\",\n \"Line2\": \"10th Floor\",\n \"City\": \"NEW YORK\",\n \"State\": \"NY\",\n \"CountryCode\": \"US\",\n \"PostalCode\": \"10019-3300\",\n \"Phone\": \"555-55555555\",\n \"Email\": \"test@test.com\"\n },\n \"MediationId\": 5380,\n \"MediationSettings\": {\n \"Old.City\": \"NEW YORK\",\n \"Old.CountryCode\": \"US\",\n \"Old.Line1\": \"142 W 57TH ST Suite 10-222\",\n \"Old.Line2\": \"10th Floor\",\n \"Old.PostalCode\": \"10019-3300\",\n \"Old.State\": \"NY\",\n \"Proposed.City\": \"NEW YORK\",\n \"Proposed.CountryCode\": \"US\",\n \"Proposed.Line1\": \"142 W 57TH ST\",\n \"Proposed.PostalCode\": \"10019-3300\",\n \"Proposed.State\": \"NY\",\n \"Score\": \"95\",\n \"Suggestion\": \"Score: 95. Insufficient data for address verification., Apartment number not found.\",\n \"PartnerSourceId\": \"1\"\n }\n }\n}" } ] }, { "name": "Update the Shipping Method", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ShipmentMethods\": [\n {\n \"OrderItemIds\": [\n \"\"\n ],\n \"NewShippingMethod\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/shippingMethod?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "shippingMethod" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Updates the shipping address for an existing order" }, "response": [ { "name": "Shipping method updated successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ShipmentMethods\": [\n {\n \"OrderItemIds\": [\n 1044686\n ],\n \"NewShippingMethod\": \"Expedited\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/shippingMethod?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "shippingMethod" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": false,\n \"UpdatedItems\": [\n 1044686\n ]\n}" } ] }, { "name": "Retrieve your order images", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/OrderImages?orderId=&recipeid={{recipeId}}&withImages=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "OrderImages" ], "query": [ { "key": "orderId", "value": "" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "withImages", "value": "true" } ] }, "description": "Updates images for items in an existing order" }, "response": [ { "name": "Retrieve order images successfully", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/OrderImages?orderId=&recipeid=&withImages=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "OrderImages" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) ID of the order to update" }, { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "withImages", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"GootenId\": 529627,\r\n .....\r\n \"Items\": [\r\n {\r\n \"OrderItemId\": 1066980,\r\n ..........\r\n \"Images\": [\r\n {\r\n \"SourceUrl\": \"https://some-cdn.com/7d744a684fe03ebc7e8de545f97739dd.jpg\",\r\n \"SpaceId\": \"CC38D\"\r\n }\r\n ]\r\n }\r\n ]\r\n ......\r\n}" } ] }, { "name": "Update your order images", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Images\": [\n {\n \"OrderItemId\": \"\",\n \"SpaceId\": \"\",\n \"Url\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/OrderImages?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "OrderImages" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) ID of the order to update" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Updates images for items in an existing order" }, "response": [ { "name": "Order images updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Images\": [\n {\n \"OrderItemId\": 1066980,\n \"SpaceId\": \"CC38D\",\n \"Url\": \"https://d3d6kbc7r9kabj.cloudfront.net/widget-live/8E5FD62F-6E00-4C85-B5C4-D258AD397B83.jpeg\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/OrderImages/?orderId=&recipeid=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "OrderImages", "" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) ID of the order to update" }, { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": false,\n \"UpdatedItems\": {\n \"UpdatedOrderItems\": [\n 1066980\n ]\n }\n}" } ] }, { "name": "Update the SKU of an item in your order", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"OrderItemUpdates\": [\n {\n \"OrderItemId\": \"\",\n \"NewPRPSku\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/orderItems?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "orderItems" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) ID of the order to update" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Updates images for items in an existing order" }, "response": [ { "name": "Item sku updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"OrderItemUpdates\": [\n {\n \"OrderItemId\": \"\",\n \"NewPRPSku\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/orderItems?orderId=&recipeid=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "orderItems" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) ID of the order to update" }, { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": false,\n \"Result\": {\n \"Id\": \"115557-258528cc-f6e7-4883-b3e4-136e99024fbc\"\n }\n}" } ] }, { "name": "Update and Push Personalized Orders to Production", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Items\": [\n {\n \"OrderItemId\": \"\",\n \"Images\": [\n {\n \"SpaceId\": \"\",\n \"Url\": \"\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/OrderCustomization?orderId=&recipeid={{recipeId}}&partnerBillingKey={{partnerBillingKey}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "OrderCustomization" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) Safe ID of the order to update" }, { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "{{partnerBillingKey}}", "description": "(Required) Partner billing key for authentication" } ] }, "description": "Updates images for items in an existing order" }, "response": [ { "name": "Order successfully pushed to production", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Items\": [\n {\n \"OrderItemId\": 9376694,\n \"Images\": [\n {\n \"SpaceId\": \"03195\",\n \"Url\": \"https://appassets.azureedge.net/temp/176f_fba78afa0ddb9655affb80304048a8d7.png\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/OrderCustomization?orderId=&recipeid=&partnerBillingKey=", "host": [ "{{baseUrl}}" ], "path": [ "api", "OrderCustomization" ], "query": [ { "key": "orderId", "value": "", "description": "(Required) Safe ID of the order to update" }, { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "partnerBillingKey", "value": "", "description": "(Required) Partner billing key for authentication" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"HadError\": false,\n \"Results\": {\n \"UpdatedOrderItems\": [\n 9376694\n ],\n \"CustomizationDone\": true\n }\n}" } ] } ] }, { "name": "Cart", "item": [ { "name": "Get Supported Currencies", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/currencies?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "currencies" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}" } ] } }, "response": [ { "name": "Supported currencies retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/currencies?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "currencies" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"Currencies\": [\n {\n \"Name\": \"string\",\n \"Code\": \"string\",\n \"Format\": \"string\"\n }\n ]\n}" } ] }, { "name": "Order Partner Price Estimates", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n\t\"ShipToAddress\": {\r\n\t\t\"Line1\": \"\",\r\n\t\t\"Line2\": \"\",\r\n\t\t\"City\": \"\",\r\n\t\t\"State\": \"\",\r\n\t\t\"CountryCode\": \"\",\r\n\t\t\"PostalCode\": \"\"\r\n\t},\r\n\t\"Items\": [{\r\n\t\t\"Quantity\": \"\",\r\n\t\t\"SKU\": \"\",\r\n\t\t\"ShipType\": \"\"\r\n\t}],\r\n\t\"Payment\": {\r\n\t\t\"CurrencyCode\": \"\",\r\n\t\t\"PartnerBillingKey\": \"\"\r\n\t}\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/price?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "price" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}" } ] } }, "response": [ { "name": "Price successfully estimated", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"ShipToAddress\": {\r\n \"Line1\": \"3116OliverStreet\",\r\n \"Line2\": \"Arlington\",\r\n \"City\": \"Arlington\",\r\n \"State\": \"TX\",\r\n \"CountryCode\": \"US\",\r\n \"PostalCode\": \"33156\"\r\n },\r\n \"Items\": [\r\n {\r\n \"SKU\": \"Apparel-DTG-Hoodie-Gildan-18500-XL-DarkGrey-Mens-CF\",\r\n \"Quantity\": 1,\r\n \"ShipType\": \"Standard\"\r\n },\r\n {\r\n \"SKU\": \"Apparel-DTG-TShirt-NL-3600-3XL-Maroon-Mens-CF\",\r\n \"Quantity\": 1,\r\n \"ShipType\": \"Standard\"\r\n },\r\n {\r\n \"SKU\": \"FramedCanvs-5x7-Black\",\r\n \"Quantity\": 1,\r\n \"ShipType\": \"Standard\"\r\n }\r\n ],\r\n \"Payment\": {\r\n \"CurrencyCode\": \"USD\",\r\n \"PartnerBillingKey\": \"IPrziHCEUoVMTFcqBoeF5up2Mu27DWsEiJAzPo9dOEg=\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/price?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "price" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"ItemsPrice\": {\n \"Items\": [\n {\n \"SKU\": \"string\",\n \"PartnerPrice\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"CustomerPrice\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"Tax\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"ShippingTax\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n }\n }\n ],\n \"ItemsTotalPrice\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n }\n },\n \"ShippingPrice\": {\n \"ShippingSurcharge\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"ShippingTotal\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n },\n \"Shipping\": [\n {\n \"SKUs\": [\n \"string\"\n ],\n \"Price\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\",\n \"CurrencyFormat\": \"string\",\n \"CurrencyDigits\": \"integer\"\n }\n }\n ]\n }\n}" } ] }, { "name": "Shipping Options", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Items\": [\n {\n \"SKU\": \"\",\n \"Quantity\": \"\"\n },\n {\n \"SKU\": \"\",\n \"Quantity\": \"\"\n }\n ],\n \"ShipToPostalCode\": \"\",\n \"ShipToCountry\": \"\",\n \"CurrencyCode\": \"\",\n \"ShipToState\": \"\",\n \"LanguageCode\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/shippingprices/?recipeid={{recipeId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "shippingprices", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" } ] }, "description": "Retrieves available shipping options for a set of products" }, "response": [ { "name": "Shipping options retrieved successfully", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Items\": [\n {\n \"SKU\": \"Apparel-DTG-TShirt-Bella-6400-M-BlackHeather-Womens-CFCB\",\n \"Quantity\": 1\n },\n {\n \"SKU\": \"FramedCanvs-5x7-Black\",\n \"Quantity\": 2\n }\n ],\n \"ShipToPostalCode\": \"115301\",\n \"ShipToState\": \"PA\",\n \"LanguageCode\": \"en\",\n \"CurrencyCode\": \"USD\",\n \"ShipToCountry\": \"US\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v/5/source/api/shippingprices/?recipeid=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "shippingprices", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\r\n \"Result\": [\r\n {\r\n \"SKUs\": [\r\n \"Apparel-DTG-TShirt-Bella-6400-M-BlackHeather-Womens-CFCB\"\r\n ],\r\n \"ShipOptions\": [\r\n {\r\n \"CarrierName\": \"Standard\",\r\n \"MethodType\": \"Standard\",\r\n \"Name\": \"Standard\",\r\n \"Price\": {\r\n \"Price\": \"decimal\",\r\n \"CurrencyCode\": \"USD\",\r\n \"FormattedPrice\": \"string\",\r\n \"CurrencyFormat\": \"${1}\",\r\n \"CurrencyDigits\": 2\r\n },\r\n \"Id\": 1,\r\n \"EstBusinessDaysTilDelivery\": 5,\r\n \"MethodId\": 3,\r\n \"MinDays\": 5,\r\n \"MaxDays\": 8\r\n },\r\n {\r\n \"CarrierName\": \"Expedited\",\r\n \"MethodType\": \"Expedited\",\r\n \"Name\": \"Expedited\",\r\n \"Price\": {\r\n \"Price\": \"decimal\",\r\n \"CurrencyCode\": \"USD\",\r\n \"FormattedPrice\": \"string\",\r\n \"CurrencyFormat\": \"${1}\",\r\n \"CurrencyDigits\": 2\r\n },\r\n \"Id\": 2,\r\n \"EstBusinessDaysTilDelivery\": 3,\r\n \"MethodId\": 5,\r\n \"MinDays\": 2,\r\n \"MaxDays\": 3\r\n },\r\n {\r\n \"CarrierName\": \"Overnight\",\r\n \"MethodType\": \"Overnight\",\r\n \"Name\": \"Overnight\",\r\n \"Price\": {\r\n \"Price\": \"decimal\",\r\n \"CurrencyCode\": \"USD\",\r\n \"FormattedPrice\": \"string\",\r\n \"CurrencyFormat\": \"${1}\",\r\n \"CurrencyDigits\": 2\r\n },\r\n \"Id\": 3,\r\n \"EstBusinessDaysTilDelivery\": 2,\r\n \"MethodId\": 7,\r\n \"MinDays\": 1,\r\n \"MaxDays\": 2\r\n }\r\n ],\r\n \"ProductionTimesOptions\": [\r\n {\r\n \"MinDays\": 4,\r\n \"MaxDays\": 4,\r\n \"AverageDays\": 4,\r\n \"TopRangePercent\": 0\r\n }\r\n ]\r\n },\r\n ...\r\n ],\r\n \"StandardSurcharge\": 0,\r\n \"ExpeditedSurcharge\": 0,\r\n \"OvernightSurcharge\": 0\r\n}" } ] }, { "name": "Shipping Price Estimates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/shippriceestimate/?recipeid={{recipeId}}&productId=&countryCode=¤cyCode=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "shippriceestimate", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "productId", "value": "", "description": "(Required) ID of the product" }, { "key": "countryCode", "value": "", "description": "(Required) Country code for shipping" }, { "key": "currencyCode", "value": "", "description": "(Required) Currency code for pricing" } ] }, "description": "Retrieves shipping price estimates for a product" }, "response": [ { "name": "Shipping price estimates retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/shippriceestimate/?recipeid=&productId=&countryCode=¤cyCode=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "shippriceestimate", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "productId", "value": "", "description": "(Required) ID of the product" }, { "key": "countryCode", "value": "", "description": "(Required) Country code for shipping" }, { "key": "currencyCode", "value": "", "description": "(Required) Currency code for pricing" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"MinPrice\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\"\n },\n \"MaxPrice\": {\n \"Price\": \"decimal\",\n \"CurrencyCode\": \"string\",\n \"FormattedPrice\": \"string\"\n },\n \"VendorCountryCode\": \"string\",\n \"CanShipExpedited\": \"boolean\",\n \"EstShipDays\": \"integer\"\n}" } ] }, { "name": "Validating Shipping Addresses", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/addressvalidation/?recipeid={{recipeId}}&line1=&line2=&city=&state=&postalCode=&countryCode=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "addressvalidation", "" ], "query": [ { "key": "recipeid", "value": "{{recipeId}}", "description": "(Required) Recipe ID" }, { "key": "line1", "value": "", "description": "(Required) Address line 1" }, { "key": "line2", "value": "", "description": "Address line 2" }, { "key": "city", "value": "", "description": "(Required) City" }, { "key": "state", "value": "", "description": "(Required) State or province" }, { "key": "postalCode", "value": "", "description": "(Required) Postal or ZIP code" }, { "key": "countryCode", "value": "", "description": "(Required) Country code" } ] }, "description": "Validates a shipping address" }, "response": [ { "name": "Address validation results retrieved successfully", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v/5/source/api/addressvalidation/?recipeid=&line1=&line2=&city=&state=&postalCode=&countryCode=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v", "5", "source", "api", "addressvalidation", "" ], "query": [ { "key": "recipeid", "value": "", "description": "(Required) Recipe ID" }, { "key": "line1", "value": "", "description": "(Required) Address line 1" }, { "key": "line2", "value": "", "description": "Address line 2" }, { "key": "city", "value": "", "description": "(Required) City" }, { "key": "state", "value": "", "description": "(Required) State or province" }, { "key": "postalCode", "value": "", "description": "(Required) Postal or ZIP code" }, { "key": "countryCode", "value": "", "description": "(Required) Country code" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "name": "Content-Type", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"IsValid\": \"boolean\",\n \"Reason\": \"string\",\n \"Score\": \"integer\",\n \"ProposedAddress\": {\n \"City\": \"string\",\n \"CountryCode\": \"string\",\n \"PostalCode\": \"string\",\n \"StateOrProvinceCode\": \"string\",\n \"StreetLines\": [\n \"string\"\n ]\n }\n}" } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.print.io" }, { "key": "geoBaseUrl", "value": "https://printio-geo.appspot.com", "type": "string" }, { "key": "cdnBaseUrl", "value": "https://gtnadminassets.blob.core.windows.net", "type": "string" }, { "key": "previewsBaseUrl", "value": "https://previews.gooten.com", "type": "string" }, { "key": "recipeId", "value": "UpdateVar", "type": "string" }, { "key": "partnerBillingKey", "value": "UpdateVar", "type": "string" }, { "key": "compression", "value": "true", "type": "string" }, { "key": "version", "value": "5", "type": "string" } ] }