{ "info": { "_postman_id": "80478dc9-da63-40b8-afdd-8ba2b18fe2bb", "name": "Commerce Layer API", "description": "Headless Commerce for Global Brands.\n\nContact Support:\n Name: API Support\n Email: support@commercelayer.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:20.000Z", "lastUpdatedBy": "35240", "uid": "35240-80478dc9-da63-40b8-afdd-8ba2b18fe2bb" }, "item": [ { "name": "addresses", "item": [ { "name": "{addressId}", "item": [ { "name": "geocoder", "item": [ { "name": "Retrieve the geocoder associated to the address", "id": "c7a85bcd-81fa-4d87-8b64-3ef3515e1e98", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/addresses/:addressId/geocoder", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "geocoder" ], "variable": [ { "id": "f51bc91a-36ff-4afa-8d63-9bbac32c44f5", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the geocoder associated to the address" }, "response": [ { "id": "15e92327-875f-422a-895e-9947b81c5ebc", "name": "The geocoder associated to the address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId/geocoder", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "geocoder" ], "variable": [ { "key": "addressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-15e92327-875f-422a-895e-9947b81c5ebc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c7a85bcd-81fa-4d87-8b64-3ef3515e1e98" } ], "id": "fd5d0e74-d3c9-4932-a431-60d605ec8148", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-fd5d0e74-d3c9-4932-a431-60d605ec8148" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the address", "id": "f981cab6-83ee-481c-b86c-6a98421d5a9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/addresses/:addressId/events", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "events" ], "variable": [ { "id": "fcf0865d-5dfa-4591-a23f-2443aa9c8e12", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the address" }, "response": [ { "id": "2d910221-9011-4c65-a9e7-e6a6a1264f9b", "name": "The events associated to the address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId/events", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "events" ], "variable": [ { "key": "addressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2d910221-9011-4c65-a9e7-e6a6a1264f9b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f981cab6-83ee-481c-b86c-6a98421d5a9d" } ], "id": "42735d0d-a372-462b-9ac5-28513036996c", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-42735d0d-a372-462b-9ac5-28513036996c" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the address", "id": "0cb2ed81-8d52-4470-9fda-161ad051ce97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/addresses/:addressId/tags", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "tags" ], "variable": [ { "id": "8f6999db-3933-491d-957c-81cfe50804af", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the address" }, "response": [ { "id": "52d6285a-9c43-4b98-b4ec-25021ab3de67", "name": "The tags associated to the address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId/tags", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "tags" ], "variable": [ { "key": "addressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-52d6285a-9c43-4b98-b4ec-25021ab3de67" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0cb2ed81-8d52-4470-9fda-161ad051ce97" } ], "id": "cbacf955-ea8b-44d7-9c54-1d5d25556f58", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-cbacf955-ea8b-44d7-9c54-1d5d25556f58" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the address", "id": "1707e4ed-51c9-40f6-80a1-f1b8c334f55e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/addresses/:addressId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "event_stores" ], "variable": [ { "id": "b1898c25-9354-4c86-8058-0fa16faaf776", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the address" }, "response": [ { "id": "e01cd3b1-7c9c-4945-8f58-4c0e494cfa4b", "name": "The event_stores associated to the address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId", "event_stores" ], "variable": [ { "key": "addressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e01cd3b1-7c9c-4945-8f58-4c0e494cfa4b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1707e4ed-51c9-40f6-80a1-f1b8c334f55e" } ], "id": "218cddf4-3d99-4faa-a482-00b0518a32bf", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-218cddf4-3d99-4faa-a482-00b0518a32bf" }, { "name": "Retrieve an address", "id": "2779a2e9-7e1e-4afc-96ac-2dcc39947674", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "variable": [ { "id": "c92eb116-f9ac-449f-a1e3-bee2cf50a928", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an address" }, "response": [ { "id": "984bb58f-bc21-445c-9d83-29f8980de25d", "name": "The address object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "variable": [ { "key": "addressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"full_address\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"is_localized\": \"\",\n \"is_geocoded\": \"\",\n \"provider_name\": \"\",\n \"map_url\": \"\",\n \"static_map_url\": \"\",\n \"billing_info\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-984bb58f-bc21-445c-9d83-29f8980de25d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2779a2e9-7e1e-4afc-96ac-2dcc39947674" }, { "name": "Update an address", "id": "eb821740-1111-430c-92ce-858b1970b02b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\",\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"billing_info\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "variable": [ { "id": "8eddd49b-b986-4858-a7d3-d083598aa7c2", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an address" }, "response": [ { "id": "a6ef67d2-ea07-459a-8f5b-02278a4dee86", "name": "The updated address object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\",\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"billing_info\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "variable": [ { "key": "addressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"full_address\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"is_localized\": \"\",\n \"is_geocoded\": \"\",\n \"provider_name\": \"\",\n \"map_url\": \"\",\n \"static_map_url\": \"\",\n \"billing_info\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a6ef67d2-ea07-459a-8f5b-02278a4dee86" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eb821740-1111-430c-92ce-858b1970b02b" }, { "name": "Delete an address", "id": "50d95bbf-dd1e-4f3b-a8b3-291da32fa123", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "variable": [ { "id": "52f29835-8561-460a-adcb-b762589784ab", "key": "addressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an address" }, "response": [ { "id": "f522a32c-1046-47f8-9dc1-293f1d99aa43", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses/:addressId", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":addressId" ], "variable": [ { "key": "addressId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f522a32c-1046-47f8-9dc1-293f1d99aa43" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-50d95bbf-dd1e-4f3b-a8b3-291da32fa123" } ], "id": "274095fd-31b5-41e6-a561-1a09dddaf2f0", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-274095fd-31b5-41e6-a561-1a09dddaf2f0" }, { "name": "List all addresses", "id": "0e652208-772f-467b-906c-3be53f9790ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "addresses" ] }, "description": "List all addresses" }, "response": [ { "id": "6ea77cd5-a72f-4cae-bcbc-ba16daaaca02", "name": "A list of address objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "addresses" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"full_address\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"is_localized\": \"\",\n \"is_geocoded\": \"\",\n \"provider_name\": \"\",\n \"map_url\": \"\",\n \"static_map_url\": \"\",\n \"billing_info\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"full_address\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"is_localized\": \"\",\n \"is_geocoded\": \"\",\n \"provider_name\": \"\",\n \"map_url\": \"\",\n \"static_map_url\": \"\",\n \"billing_info\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6ea77cd5-a72f-4cae-bcbc-ba16daaaca02" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0e652208-772f-467b-906c-3be53f9790ac" }, { "name": "Create an address", "id": "fb4448e5-684d-49a3-99f2-c964ec02b7cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"attributes\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"line_2\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"billing_info\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "addresses" ] }, "description": "Create an address" }, "response": [ { "id": "e177d0da-8d25-4ae7-a3de-a324b6b2fc1d", "name": "The created address object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"addresses\",\n \"attributes\": {\n \"line_1\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"line_2\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"billing_info\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/addresses", "host": [ "{{baseUrl}}" ], "path": [ "addresses" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"business\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"company\": \"\",\n \"full_name\": \"\",\n \"line_1\": \"\",\n \"line_2\": \"\",\n \"city\": \"\",\n \"zip_code\": \"\",\n \"state_code\": \"\",\n \"country_code\": \"\",\n \"phone\": \"\",\n \"full_address\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"notes\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"is_localized\": \"\",\n \"is_geocoded\": \"\",\n \"provider_name\": \"\",\n \"map_url\": \"\",\n \"static_map_url\": \"\",\n \"billing_info\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e177d0da-8d25-4ae7-a3de-a324b6b2fc1d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb4448e5-684d-49a3-99f2-c964ec02b7cd" } ], "id": "d7a1fc1f-3784-4833-9713-c5fe09ddf79c", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-d7a1fc1f-3784-4833-9713-c5fe09ddf79c" }, { "name": "adjustments", "item": [ { "name": "{adjustmentId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the adjustment", "id": "010d2523-a296-48ca-aecc-adc880fcddf9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId", "event_stores" ], "variable": [ { "id": "5a1bc807-b424-47f7-a3a8-1c9d596a9191", "key": "adjustmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the adjustment" }, "response": [ { "id": "649d6019-6136-41bf-ada6-78b39aee3a21", "name": "The event_stores associated to the adjustment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId", "event_stores" ], "variable": [ { "key": "adjustmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-649d6019-6136-41bf-ada6-78b39aee3a21" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-010d2523-a296-48ca-aecc-adc880fcddf9" } ], "id": "1b4066e6-6b72-48bd-ad16-a528ea9dce7d", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-1b4066e6-6b72-48bd-ad16-a528ea9dce7d" }, { "name": "Retrieve an adjustment", "id": "3ffb3373-b12c-41e7-990d-13e44846a758", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId" ], "variable": [ { "id": "b5ee98e4-76a1-4a90-95e2-55a87ab0d43d", "key": "adjustmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an adjustment" }, "response": [ { "id": "f6f7aa51-8645-428d-a852-0bca760b3c25", "name": "The adjustment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId" ], "variable": [ { "key": "adjustmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adjustments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"distribute_discount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f6f7aa51-8645-428d-a852-0bca760b3c25" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3ffb3373-b12c-41e7-990d-13e44846a758" }, { "name": "Update an adjustment", "id": "14d054b9-dd92-466f-a7a7-14ebc8dc04f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"distribute_discount\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId" ], "variable": [ { "id": "38000b7b-97b7-413e-ad8d-0ae4c2cb7dba", "key": "adjustmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an adjustment" }, "response": [ { "id": "a10e4995-082a-40a0-9107-73043b65e1ff", "name": "The updated adjustment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"distribute_discount\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId" ], "variable": [ { "key": "adjustmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adjustments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"distribute_discount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a10e4995-082a-40a0-9107-73043b65e1ff" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-14d054b9-dd92-466f-a7a7-14ebc8dc04f7" }, { "name": "Delete an adjustment", "id": "8d4b47cb-0653-4831-8cb1-1099555e2300", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId" ], "variable": [ { "id": "1cf93978-b135-4c51-92bc-bb8f0238c025", "key": "adjustmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an adjustment" }, "response": [ { "id": "785c2ad2-0214-459a-9b08-8854d0b89529", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adjustments/:adjustmentId", "host": [ "{{baseUrl}}" ], "path": [ "adjustments", ":adjustmentId" ], "variable": [ { "key": "adjustmentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-785c2ad2-0214-459a-9b08-8854d0b89529" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8d4b47cb-0653-4831-8cb1-1099555e2300" } ], "id": "bf05fa75-bba8-48bb-941c-8ccb0504807b", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-bf05fa75-bba8-48bb-941c-8ccb0504807b" }, { "name": "List all adjustments", "id": "46148294-524b-46c9-9b41-9e5b820d6d0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ] }, "description": "List all adjustments" }, "response": [ { "id": "ca1eac00-1f60-430e-bc08-f6f0f69a5400", "name": "A list of adjustment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"adjustments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"distribute_discount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"adjustments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"distribute_discount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ca1eac00-1f60-430e-bc08-f6f0f69a5400" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-46148294-524b-46c9-9b41-9e5b820d6d0c" }, { "name": "Create an adjustment", "id": "b2546730-42b3-4db6-8f2c-3d786317c751", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adjustments\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"distribute_discount\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ] }, "description": "Create an adjustment" }, "response": [ { "id": "a1a47326-b703-4e2d-9174-f4c3697a6641", "name": "The created adjustment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adjustments\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"distribute_discount\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adjustments", "host": [ "{{baseUrl}}" ], "path": [ "adjustments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adjustments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"distribute_discount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a1a47326-b703-4e2d-9174-f4c3697a6641" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b2546730-42b3-4db6-8f2c-3d786317c751" } ], "id": "75fe290d-54aa-414f-8422-28c89a21291d", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-75fe290d-54aa-414f-8422-28c89a21291d" }, { "name": "adyen_gateways", "item": [ { "name": "{adyenGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the adyen gateway", "id": "d40f5cc5-ae3d-4122-b962-aa88bf876904", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId", "payment_methods" ], "variable": [ { "id": "636b321e-8330-47b9-a82d-bff450a1b590", "key": "adyenGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the adyen gateway" }, "response": [ { "id": "cc2c995c-18e2-4ef3-8e4a-35050ad34ef0", "name": "The payment_methods associated to the adyen gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId", "payment_methods" ], "variable": [ { "key": "adyenGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cc2c995c-18e2-4ef3-8e4a-35050ad34ef0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d40f5cc5-ae3d-4122-b962-aa88bf876904" } ], "id": "c76139ea-6741-4fd1-b723-651d0e0e0979", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c76139ea-6741-4fd1-b723-651d0e0e0979" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the adyen gateway", "id": "8f50db48-79d4-49d0-83eb-6dab20f4591f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId", "event_stores" ], "variable": [ { "id": "044d0919-483a-40c8-b4d1-e96057aa2f3e", "key": "adyenGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the adyen gateway" }, "response": [ { "id": "545aff44-82ef-4e7b-8b76-a014e146a718", "name": "The event_stores associated to the adyen gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId", "event_stores" ], "variable": [ { "key": "adyenGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-545aff44-82ef-4e7b-8b76-a014e146a718" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8f50db48-79d4-49d0-83eb-6dab20f4591f" } ], "id": "9970d4ab-503e-4d39-a713-657afaf653b8", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-9970d4ab-503e-4d39-a713-657afaf653b8" }, { "name": "adyen_payments", "item": [ { "name": "Retrieve the adyen payments associated to the adyen gateway", "id": "4fb579bb-6b8d-4939-9652-e649a5443f45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId/adyen_payments", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId", "adyen_payments" ], "variable": [ { "id": "3f6c79c6-d515-4cea-ba3f-e817a3c77da7", "key": "adyenGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the adyen payments associated to the adyen gateway" }, "response": [ { "id": "835669a2-dac9-4e8f-89e7-d2e7218bb675", "name": "The adyen_payments associated to the adyen gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId/adyen_payments", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId", "adyen_payments" ], "variable": [ { "key": "adyenGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-835669a2-dac9-4e8f-89e7-d2e7218bb675" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4fb579bb-6b8d-4939-9652-e649a5443f45" } ], "id": "c62ef4b9-6619-434b-8d74-ff6e3ea0c9e6", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c62ef4b9-6619-434b-8d74-ff6e3ea0c9e6" }, { "name": "Retrieve an adyen gateway", "id": "a0fbd533-cfd8-4167-9a21-5f1a7d7fcf8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId" ], "variable": [ { "id": "686eb8f8-f91c-45bd-a78b-0c1e916080c7", "key": "adyenGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an adyen gateway" }, "response": [ { "id": "7493ee30-49a9-487f-ac9d-9e30a574919a", "name": "The adyen gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId" ], "variable": [ { "key": "adyenGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adyen_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"adyen_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7493ee30-49a9-487f-ac9d-9e30a574919a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a0fbd533-cfd8-4167-9a21-5f1a7d7fcf8e" }, { "name": "Update an adyen gateway", "id": "0ca88817-707a-4155-8347-01e4ab3e0832", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"merchant_account\": \"\",\n \"api_key\": \"\",\n \"public_key\": \"\",\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\"\n },\n \"relationships\": {\n \"adyen_payments\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId" ], "variable": [ { "id": "abdc74e8-5b52-475e-8514-9366e3402e15", "key": "adyenGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an adyen gateway" }, "response": [ { "id": "525dcb4f-2981-46f0-92b8-db6f09dd1a41", "name": "The updated adyen gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"merchant_account\": \"\",\n \"api_key\": \"\",\n \"public_key\": \"\",\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\"\n },\n \"relationships\": {\n \"adyen_payments\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId" ], "variable": [ { "key": "adyenGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adyen_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"adyen_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-525dcb4f-2981-46f0-92b8-db6f09dd1a41" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0ca88817-707a-4155-8347-01e4ab3e0832" }, { "name": "Delete an adyen gateway", "id": "0380a801-ca95-4a17-aac3-1ae3deeed1a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId" ], "variable": [ { "id": "449894e5-62a9-4e58-bb3c-a8f39828a424", "key": "adyenGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an adyen gateway" }, "response": [ { "id": "79c35692-856a-4d17-bb27-6fca5d33fb18", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_gateways/:adyenGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways", ":adyenGatewayId" ], "variable": [ { "key": "adyenGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-79c35692-856a-4d17-bb27-6fca5d33fb18" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0380a801-ca95-4a17-aac3-1ae3deeed1a7" } ], "id": "20c8dde0-c5c9-42fb-ba45-1ef27ceac932", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-20c8dde0-c5c9-42fb-ba45-1ef27ceac932" }, { "name": "List all adyen gateways", "id": "3427ce34-e2fb-4684-bb33-f4b45d4a57a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/adyen_gateways", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways" ] }, "description": "List all adyen gateways" }, "response": [ { "id": "245b3f99-dcde-41ef-a1db-cdfeb14b1afb", "name": "A list of adyen gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_gateways", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"adyen_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"adyen_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"adyen_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"adyen_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-245b3f99-dcde-41ef-a1db-cdfeb14b1afb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3427ce34-e2fb-4684-bb33-f4b45d4a57a4" }, { "name": "Create an adyen gateway", "id": "f9634c26-d148-444b-9c28-a3d0eaf10014", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"merchant_account\": \"\",\n \"api_key\": \"\",\n \"live_url_prefix\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"public_key\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\"\n },\n \"relationships\": {\n \"adyen_payments\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_gateways", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways" ] }, "description": "Create an adyen gateway" }, "response": [ { "id": "fe0c1c3d-df73-42e7-99e0-6e64cdbe1abf", "name": "The created adyen gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"merchant_account\": \"\",\n \"api_key\": \"\",\n \"live_url_prefix\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"public_key\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\"\n },\n \"relationships\": {\n \"adyen_payments\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_gateways", "host": [ "{{baseUrl}}" ], "path": [ "adyen_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adyen_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"live_url_prefix\": \"\",\n \"api_version\": \"\",\n \"async_api\": \"\",\n \"partial_payments\": \"\",\n \"order_expiration_mins\": \"\",\n \"native_customer_payment_sources\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"adyen_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fe0c1c3d-df73-42e7-99e0-6e64cdbe1abf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f9634c26-d148-444b-9c28-a3d0eaf10014" } ], "id": "766f37ee-1aa8-47cd-8f8c-a611c7b7705a", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-766f37ee-1aa8-47cd-8f8c-a611c7b7705a" }, { "name": "adyen_payments", "item": [ { "name": "{adyenPaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the adyen payment", "id": "801c1064-022d-407e-a16e-c57f7fc803c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId", "order" ], "variable": [ { "id": "2925c40c-985c-4e68-9a90-364fb8f183ef", "key": "adyenPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the adyen payment" }, "response": [ { "id": "839fe9dc-e546-43a6-8fa3-a47ed05f3c94", "name": "The order associated to the adyen payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId", "order" ], "variable": [ { "key": "adyenPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-839fe9dc-e546-43a6-8fa3-a47ed05f3c94" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-801c1064-022d-407e-a16e-c57f7fc803c0" } ], "id": "535785a3-1635-4083-945f-36da5e1f91ea", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-535785a3-1635-4083-945f-36da5e1f91ea" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the adyen payment", "id": "3e38cb31-e68f-442b-bae7-77c5dc41bb6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId", "payment_gateway" ], "variable": [ { "id": "cfab7550-4ea5-434a-aeb9-4b5f67825725", "key": "adyenPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the adyen payment" }, "response": [ { "id": "40a260d4-108f-404b-b428-0a59029ce65a", "name": "The payment_gateway associated to the adyen payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId", "payment_gateway" ], "variable": [ { "key": "adyenPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-40a260d4-108f-404b-b428-0a59029ce65a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3e38cb31-e68f-442b-bae7-77c5dc41bb6e" } ], "id": "4ff88384-c573-471c-9cbd-924c955b7efb", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-4ff88384-c573-471c-9cbd-924c955b7efb" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the adyen payment", "id": "ab28e1dd-b566-4d0d-8e11-8563bd93c38f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId", "event_stores" ], "variable": [ { "id": "f8217b1b-a55e-4836-aa3f-fe60f47f8aa2", "key": "adyenPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the adyen payment" }, "response": [ { "id": "abbab322-3fc4-48ce-a87a-e2a8a06b06d3", "name": "The event_stores associated to the adyen payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId", "event_stores" ], "variable": [ { "key": "adyenPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-abbab322-3fc4-48ce-a87a-e2a8a06b06d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ab28e1dd-b566-4d0d-8e11-8563bd93c38f" } ], "id": "8657f63a-ad29-497e-94d0-73ab5d8f55a9", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8657f63a-ad29-497e-94d0-73ab5d8f55a9" }, { "name": "Retrieve an adyen payment", "id": "9b41a4c7-dee0-4c8d-be99-4f5c7e2fd8af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId" ], "variable": [ { "id": "6404af91-0c4f-486c-8b6b-3f9ce8c3bb3c", "key": "adyenPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an adyen payment" }, "response": [ { "id": "97aadeb0-6dc8-4f7f-95d7-78281af3c5fd", "name": "The adyen payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId" ], "variable": [ { "key": "adyenPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adyen_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-97aadeb0-6dc8-4f7f-95d7-78281af3c5fd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9b41a4c7-dee0-4c8d-be99-4f5c7e2fd8af" }, { "name": "Update an adyen payment", "id": "4291ceb9-5ace-46cd-8175-b11754c4b2b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"_authorize\": \"\",\n \"_details\": \"\",\n \"_balance\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId" ], "variable": [ { "id": "62fc89bd-a51e-45b4-afb5-a6bf41946a8a", "key": "adyenPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an adyen payment" }, "response": [ { "id": "7ad470f6-564c-4816-a78e-ebc621aedd9d", "name": "The updated adyen payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"_authorize\": \"\",\n \"_details\": \"\",\n \"_balance\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId" ], "variable": [ { "key": "adyenPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adyen_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7ad470f6-564c-4816-a78e-ebc621aedd9d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4291ceb9-5ace-46cd-8175-b11754c4b2b6" }, { "name": "Delete an adyen payment", "id": "93ba7562-330d-4cd1-94f3-c2b27506d6a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId" ], "variable": [ { "id": "990b1489-ced0-4588-a87b-70c530afbe5e", "key": "adyenPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an adyen payment" }, "response": [ { "id": "c40af33e-c1b4-4a17-919e-a676b787783b", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_payments/:adyenPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments", ":adyenPaymentId" ], "variable": [ { "key": "adyenPaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c40af33e-c1b4-4a17-919e-a676b787783b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-93ba7562-330d-4cd1-94f3-c2b27506d6a5" } ], "id": "e0abd39c-a610-40ae-985f-764f8c074fb0", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-e0abd39c-a610-40ae-985f-764f8c074fb0" }, { "name": "List all adyen payments", "id": "a28e1d1c-8ad6-44c2-89c4-e2ca980efaaa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/adyen_payments", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments" ] }, "description": "List all adyen payments" }, "response": [ { "id": "02abd135-7498-4be4-bd3b-562600544c76", "name": "A list of adyen payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/adyen_payments", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"adyen_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"adyen_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-02abd135-7498-4be4-bd3b-562600544c76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a28e1d1c-8ad6-44c2-89c4-e2ca980efaaa" }, { "name": "Create an adyen payment", "id": "ab8a8c1a-a003-4546-9eb1-90005a143689", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_payments", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments" ] }, "description": "Create an adyen payment" }, "response": [ { "id": "3e2bcfb8-8e48-48e7-92f1-91b069869dd8", "name": "The created adyen payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/adyen_payments", "host": [ "{{baseUrl}}" ], "path": [ "adyen_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"adyen_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3e2bcfb8-8e48-48e7-92f1-91b069869dd8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ab8a8c1a-a003-4546-9eb1-90005a143689" } ], "id": "ff67e095-2563-4ce6-8bb7-1f4d4f4b9190", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-ff67e095-2563-4ce6-8bb7-1f4d4f4b9190" }, { "name": "application", "item": [ { "name": "Retrieve the application", "id": "eb70942e-ea3c-407f-915e-adffefe658c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/application", "host": [ "{{baseUrl}}" ], "path": [ "application" ] }, "description": "Retrieve the application" }, "response": [ { "id": "d3be63c4-a292-416a-a7b0-62fdafeed771", "name": "The application object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application", "host": [ "{{baseUrl}}" ], "path": [ "application" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"application\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"orders\",\n \"public_access\": \"\",\n \"redirect_uri\": \"\",\n \"scopes\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d3be63c4-a292-416a-a7b0-62fdafeed771" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eb70942e-ea3c-407f-915e-adffefe658c2" } ], "id": "f4df92ec-8e0d-48fc-b14a-fa3f4b5a6ba9", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f4df92ec-8e0d-48fc-b14a-fa3f4b5a6ba9" }, { "name": "attachments", "item": [ { "name": "{attachmentId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the attachment", "id": "16409a91-ab4e-4da4-9b37-231582f33285", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/attachments/:attachmentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId", "event_stores" ], "variable": [ { "id": "3e2739f3-1fa4-410a-9504-d49c107c330e", "key": "attachmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the attachment" }, "response": [ { "id": "8f23336c-958d-40b5-ab44-5c9b956be206", "name": "The event_stores associated to the attachment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/attachments/:attachmentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId", "event_stores" ], "variable": [ { "key": "attachmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8f23336c-958d-40b5-ab44-5c9b956be206" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-16409a91-ab4e-4da4-9b37-231582f33285" } ], "id": "f83dbc1b-91f1-4d4f-a347-3dcff2c43712", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f83dbc1b-91f1-4d4f-a347-3dcff2c43712" }, { "name": "Retrieve an attachment", "id": "169b9cf1-4ebf-44a8-8d4b-3e07fe268bee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId" ], "variable": [ { "id": "3706a7cf-ca6c-499a-b247-111f2009156c", "key": "attachmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an attachment" }, "response": [ { "id": "efed32dd-4229-40d1-a980-a6c5ad7651ac", "name": "The attachment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId" ], "variable": [ { "key": "attachmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"attachments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-efed32dd-4229-40d1-a980-a6c5ad7651ac" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-169b9cf1-4ebf-44a8-8d4b-3e07fe268bee" }, { "name": "Update an attachment", "id": "3d06fba8-01ee-44df-bdb0-dfddeb17dea8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"bing_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId" ], "variable": [ { "id": "578fe35a-0cdc-4a1b-91a6-1ac13eb0d9e4", "key": "attachmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an attachment" }, "response": [ { "id": "bb9c12ad-c59a-4301-8101-00faf86d603a", "name": "The updated attachment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"bing_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId" ], "variable": [ { "key": "attachmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"attachments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bb9c12ad-c59a-4301-8101-00faf86d603a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3d06fba8-01ee-44df-bdb0-dfddeb17dea8" }, { "name": "Delete an attachment", "id": "28448398-4137-4f5f-a543-31a0e2295048", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId" ], "variable": [ { "id": "6f5e06ec-46d1-434e-b47a-476aff43ca33", "key": "attachmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an attachment" }, "response": [ { "id": "64b305f4-830d-4c0b-8ab7-a5354fc753b0", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "attachments", ":attachmentId" ], "variable": [ { "key": "attachmentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-64b305f4-830d-4c0b-8ab7-a5354fc753b0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-28448398-4137-4f5f-a543-31a0e2295048" } ], "id": "6a98f57c-a343-41ae-97b7-72c6b89461ed", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-6a98f57c-a343-41ae-97b7-72c6b89461ed" }, { "name": "List all attachments", "id": "c4b2abec-8eb0-4991-8ae9-a700505158b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/attachments", "host": [ "{{baseUrl}}" ], "path": [ "attachments" ] }, "description": "List all attachments" }, "response": [ { "id": "88c34380-473b-48db-9b55-254e5d22a469", "name": "A list of attachment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/attachments", "host": [ "{{baseUrl}}" ], "path": [ "attachments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"attachments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"attachments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-88c34380-473b-48db-9b55-254e5d22a469" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c4b2abec-8eb0-4991-8ae9-a700505158b6" }, { "name": "Create an attachment", "id": "e8621c0b-e9aa-4e30-997d-748f27d71ac5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"attachments\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/attachments", "host": [ "{{baseUrl}}" ], "path": [ "attachments" ] }, "description": "Create an attachment" }, "response": [ { "id": "65e2a0af-497a-41c2-a0c7-6a47103b00d9", "name": "The created attachment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"attachments\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/attachments", "host": [ "{{baseUrl}}" ], "path": [ "attachments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"attachments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-65e2a0af-497a-41c2-a0c7-6a47103b00d9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e8621c0b-e9aa-4e30-997d-748f27d71ac5" } ], "id": "4d8645c7-d63e-46f7-aa58-bd35e9b83132", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-4d8645c7-d63e-46f7-aa58-bd35e9b83132" }, { "name": "authorizations", "item": [ { "name": "{authorizationId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the authorization", "id": "118e4ca2-2ded-43bd-a041-ce5d78cf5cc5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/order", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "order" ], "variable": [ { "id": "08fa8506-e549-43a2-b247-b9baad88155f", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the authorization" }, "response": [ { "id": "4fdbf898-7739-458a-b86e-4b037777f1f6", "name": "The order associated to the authorization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/order", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "order" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4fdbf898-7739-458a-b86e-4b037777f1f6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-118e4ca2-2ded-43bd-a041-ce5d78cf5cc5" } ], "id": "855a2636-fe20-499e-afbd-300152a62a93", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-855a2636-fe20-499e-afbd-300152a62a93" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the authorization", "id": "10393810-aeb8-4e65-b21d-cadedf8004d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "attachments" ], "variable": [ { "id": "0d990e87-5109-4524-903f-52eba469c362", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the authorization" }, "response": [ { "id": "41fb44fa-2e89-47f6-ae79-7a30507fea6b", "name": "The attachments associated to the authorization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "attachments" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-41fb44fa-2e89-47f6-ae79-7a30507fea6b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-10393810-aeb8-4e65-b21d-cadedf8004d1" } ], "id": "d40c1a33-89b0-40f9-a43c-4286f5723088", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-d40c1a33-89b0-40f9-a43c-4286f5723088" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the authorization", "id": "32a2027a-32c6-44ba-8f91-95d0221f701c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/events", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "events" ], "variable": [ { "id": "830658d8-c829-40f9-91d9-bff1e3f12ed9", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the authorization" }, "response": [ { "id": "3205555f-c9b6-44f4-a028-80b41f92b73b", "name": "The events associated to the authorization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/events", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "events" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3205555f-c9b6-44f4-a028-80b41f92b73b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-32a2027a-32c6-44ba-8f91-95d0221f701c" } ], "id": "c33d3fac-5ba7-46de-bf04-2e2d0d9ddd92", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c33d3fac-5ba7-46de-bf04-2e2d0d9ddd92" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the authorization", "id": "2e1abafe-4887-48ec-9cb9-1b96ab1b70ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "event_stores" ], "variable": [ { "id": "3bee46eb-a6d1-4ab3-b1ed-e9ace773a85d", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the authorization" }, "response": [ { "id": "77396277-4af0-430b-9f07-d5afdf5a4998", "name": "The event_stores associated to the authorization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "event_stores" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-77396277-4af0-430b-9f07-d5afdf5a4998" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e1abafe-4887-48ec-9cb9-1b96ab1b70ad" } ], "id": "209ada96-5075-4b63-84b5-008b23585983", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-209ada96-5075-4b63-84b5-008b23585983" }, { "name": "captures", "item": [ { "name": "Retrieve the captures associated to the authorization", "id": "53218b64-50c0-4926-9bd4-9b52637a4843", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/captures", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "captures" ], "variable": [ { "id": "ee6dffbc-0f52-4448-ba3f-4bcc44dd28fe", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the captures associated to the authorization" }, "response": [ { "id": "2843ff37-ba56-42e3-80ec-5d435b3bf0f8", "name": "The captures associated to the authorization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/captures", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "captures" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2843ff37-ba56-42e3-80ec-5d435b3bf0f8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-53218b64-50c0-4926-9bd4-9b52637a4843" } ], "id": "8ac04921-6c1b-4d0a-92d1-4ecef3b956e4", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8ac04921-6c1b-4d0a-92d1-4ecef3b956e4" }, { "name": "voids", "item": [ { "name": "Retrieve the voids associated to the authorization", "id": "4852f1e4-2843-4290-b247-584d6e2da51f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/voids", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "voids" ], "variable": [ { "id": "952040e3-3bf0-4005-a4ce-f4a0bd641095", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the voids associated to the authorization" }, "response": [ { "id": "1587c552-e0a9-4e87-ac03-6207d0320116", "name": "The voids associated to the authorization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId/voids", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId", "voids" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1587c552-e0a9-4e87-ac03-6207d0320116" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4852f1e4-2843-4290-b247-584d6e2da51f" } ], "id": "61085ddd-4347-48de-803e-a8ca4530b9de", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-61085ddd-4347-48de-803e-a8ca4530b9de" }, { "name": "Retrieve an authorization", "id": "ab55409c-db1f-4f39-be87-e7695deaa618", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId" ], "variable": [ { "id": "27d265a8-3f2b-40c4-9bcc-bdfced503a69", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an authorization" }, "response": [ { "id": "4a29679d-ec9e-4edb-9c85-daea9a0e64ef", "name": "The authorization object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"authorizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"captures\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4a29679d-ec9e-4edb-9c85-daea9a0e64ef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ab55409c-db1f-4f39-be87-e7695deaa618" }, { "name": "Update an authorization", "id": "b71d640e-0cf2-483f-b689-caa77efb386c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_capture\": \"\",\n \"_capture_amount_cents\": \"\",\n \"_void\": \"\",\n \"_cancel\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId" ], "variable": [ { "id": "086b3a33-0140-4dbf-8ccb-14293d72770b", "key": "authorizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an authorization" }, "response": [ { "id": "c94f350c-d133-4c75-8062-c99455945ce7", "name": "The updated authorization object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_capture\": \"\",\n \"_capture_amount_cents\": \"\",\n \"_void\": \"\",\n \"_cancel\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/authorizations/:authorizationId", "host": [ "{{baseUrl}}" ], "path": [ "authorizations", ":authorizationId" ], "variable": [ { "key": "authorizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"authorizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"captures\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c94f350c-d133-4c75-8062-c99455945ce7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b71d640e-0cf2-483f-b689-caa77efb386c" } ], "id": "f8fc31c5-c29b-41d6-beb7-014586504eaa", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f8fc31c5-c29b-41d6-beb7-014586504eaa" }, { "name": "List all authorizations", "id": "2be0d994-9b6e-4aae-9657-b8b6bfb86f46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "authorizations" ] }, "description": "List all authorizations" }, "response": [ { "id": "e44768d6-6eb6-4fd3-8e97-388f5c58e685", "name": "A list of authorization objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "authorizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"authorizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"voids\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"authorizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e44768d6-6eb6-4fd3-8e97-388f5c58e685" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2be0d994-9b6e-4aae-9657-b8b6bfb86f46" } ], "id": "8e77a32f-a5f2-4d73-9b66-c10ab696309c", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8e77a32f-a5f2-4d73-9b66-c10ab696309c" }, { "name": "avalara_accounts", "item": [ { "name": "{avalaraAccountId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the avalara account", "id": "c81b74e2-b207-4d66-9778-0a3c039602b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "markets" ], "variable": [ { "id": "cefa6cba-78ea-4a03-95be-83b3bfbe0ade", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the avalara account" }, "response": [ { "id": "1ee67440-d459-48ca-a4e6-58b0756a1db8", "name": "The markets associated to the avalara account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "markets" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1ee67440-d459-48ca-a4e6-58b0756a1db8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c81b74e2-b207-4d66-9778-0a3c039602b5" } ], "id": "871d27ed-a876-4976-b274-2088fafbd8ae", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-871d27ed-a876-4976-b274-2088fafbd8ae" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the avalara account", "id": "adc98fe2-9c83-4b98-a9ce-080ba39e5189", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "attachments" ], "variable": [ { "id": "7fe90e19-2ff7-4204-a548-87078ad4fce3", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the avalara account" }, "response": [ { "id": "794f1173-0071-44e9-ac2c-91399a3f07b4", "name": "The attachments associated to the avalara account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "attachments" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-794f1173-0071-44e9-ac2c-91399a3f07b4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-adc98fe2-9c83-4b98-a9ce-080ba39e5189" } ], "id": "7b75ca08-180b-47ed-9611-ae95cc614ccd", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7b75ca08-180b-47ed-9611-ae95cc614ccd" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the avalara account", "id": "6a375028-7f57-42f6-837e-8c9ea23ea4bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "events" ], "variable": [ { "id": "2da60694-b5f8-401f-ae27-18229ddcf1c6", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the avalara account" }, "response": [ { "id": "d324ecb7-15d4-4014-8f35-b1f8c4c84abf", "name": "The events associated to the avalara account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "events" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d324ecb7-15d4-4014-8f35-b1f8c4c84abf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6a375028-7f57-42f6-837e-8c9ea23ea4bd" } ], "id": "1b035132-bfe4-488c-81ab-478feddfdf65", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-1b035132-bfe4-488c-81ab-478feddfdf65" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the avalara account", "id": "cb6a6236-facb-46bc-b09e-b023ec97fd1a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "event_stores" ], "variable": [ { "id": "91b0fffc-65c8-4508-a63d-f4e686a5b9f3", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the avalara account" }, "response": [ { "id": "f330f8b8-236d-4ba8-bb86-2a0db55ea55a", "name": "The event_stores associated to the avalara account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "event_stores" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f330f8b8-236d-4ba8-bb86-2a0db55ea55a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cb6a6236-facb-46bc-b09e-b023ec97fd1a" } ], "id": "30487ed9-0478-4f59-aea5-c55aefcc04ff", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-30487ed9-0478-4f59-aea5-c55aefcc04ff" }, { "name": "tax_categories", "item": [ { "name": "Retrieve the tax categories associated to the avalara account", "id": "9d78bba0-a813-4ba6-b4af-d3a53eed1cec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "tax_categories" ], "variable": [ { "id": "6a15c293-5ddd-481e-a7de-4011ff8c42c3", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tax categories associated to the avalara account" }, "response": [ { "id": "a230303b-eeac-4ad4-b8f4-2b05bde6a880", "name": "The tax_categories associated to the avalara account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId", "tax_categories" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a230303b-eeac-4ad4-b8f4-2b05bde6a880" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9d78bba0-a813-4ba6-b4af-d3a53eed1cec" } ], "id": "c2367991-cb88-4cb5-a023-5b5f9e53b5b8", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c2367991-cb88-4cb5-a023-5b5f9e53b5b8" }, { "name": "Retrieve an avalara account", "id": "74ce5c9a-7f6c-4c47-a8e0-f40796c9ab94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId" ], "variable": [ { "id": "48cb9c79-e2e5-4e4c-b3a4-1927fb7aecf3", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an avalara account" }, "response": [ { "id": "9ec4f01e-3458-41dd-ad68-2d8774feae48", "name": "The avalara account object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"avalara_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9ec4f01e-3458-41dd-ad68-2d8774feae48" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-74ce5c9a-7f6c-4c47-a8e0-f40796c9ab94" }, { "name": "Update an avalara account", "id": "0fb8b2bd-d85d-4151-b0d6-1773cf5d3a82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"password\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId" ], "variable": [ { "id": "efa90bf1-4bfc-42ed-b2c7-b3bee3b802f3", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an avalara account" }, "response": [ { "id": "d5b48913-704e-4b20-8fa6-c12b860a3523", "name": "The updated avalara account object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"password\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"avalara_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d5b48913-704e-4b20-8fa6-c12b860a3523" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0fb8b2bd-d85d-4151-b0d6-1773cf5d3a82" }, { "name": "Delete an avalara account", "id": "456bfb75-1e08-4d31-ae28-0fb2285530c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId" ], "variable": [ { "id": "6068ca86-d589-430b-b95b-c5b899242c85", "key": "avalaraAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an avalara account" }, "response": [ { "id": "439f1a3d-f7f7-4809-9d10-3a6afa39df4c", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts/:avalaraAccountId", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts", ":avalaraAccountId" ], "variable": [ { "key": "avalaraAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-439f1a3d-f7f7-4809-9d10-3a6afa39df4c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-456bfb75-1e08-4d31-ae28-0fb2285530c8" } ], "id": "719f8e13-f14f-47c6-bba1-0306b43fa13f", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-719f8e13-f14f-47c6-bba1-0306b43fa13f" }, { "name": "List all avalara accounts", "id": "855b6042-1a1e-4d6e-b82a-efb49bed5856", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/avalara_accounts", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts" ] }, "description": "List all avalara accounts" }, "response": [ { "id": "78f880a9-53f7-4a91-86ce-dbd0765f507f", "name": "A list of avalara account objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/avalara_accounts", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"avalara_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"avalara_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-78f880a9-53f7-4a91-86ce-dbd0765f507f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-855b6042-1a1e-4d6e-b82a-efb49bed5856" }, { "name": "Create an avalara account", "id": "d7ca2157-efe1-4954-be58-ebaea0a19f56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"company_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/avalara_accounts", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts" ] }, "description": "Create an avalara account" }, "response": [ { "id": "9e60942a-63df-4fba-92d8-cf2199f50cd2", "name": "The created avalara account object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"company_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/avalara_accounts", "host": [ "{{baseUrl}}" ], "path": [ "avalara_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"avalara_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9e60942a-63df-4fba-92d8-cf2199f50cd2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d7ca2157-efe1-4954-be58-ebaea0a19f56" } ], "id": "dcbe4617-4615-4df9-b6f1-4091870cd2b7", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-dcbe4617-4615-4df9-b6f1-4091870cd2b7" }, { "name": "axerve_gateways", "item": [ { "name": "{axerveGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the axerve gateway", "id": "a1246ea9-378a-449b-a250-06918e6d59e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId", "payment_methods" ], "variable": [ { "id": "015cca51-cbe9-46bf-8d8d-54c8fa176ce6", "key": "axerveGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the axerve gateway" }, "response": [ { "id": "a5e2d0bf-acf7-40a2-a1ee-5884c461796d", "name": "The payment_methods associated to the axerve gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId", "payment_methods" ], "variable": [ { "key": "axerveGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a5e2d0bf-acf7-40a2-a1ee-5884c461796d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a1246ea9-378a-449b-a250-06918e6d59e9" } ], "id": "a575f1e6-f144-4831-a132-e376715859f0", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-a575f1e6-f144-4831-a132-e376715859f0" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the axerve gateway", "id": "8ebca347-f879-465e-a8d8-2a8c61fdb092", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId", "event_stores" ], "variable": [ { "id": "a6fa47f2-55a1-4133-be71-7c6f17c4be77", "key": "axerveGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the axerve gateway" }, "response": [ { "id": "f8933c98-0560-4701-a424-9cea20f3e8df", "name": "The event_stores associated to the axerve gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId", "event_stores" ], "variable": [ { "key": "axerveGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f8933c98-0560-4701-a424-9cea20f3e8df" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8ebca347-f879-465e-a8d8-2a8c61fdb092" } ], "id": "6429953a-297d-4884-a3a8-865eb1154e73", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-6429953a-297d-4884-a3a8-865eb1154e73" }, { "name": "axerve_payments", "item": [ { "name": "Retrieve the axerve payments associated to the axerve gateway", "id": "11325d1a-6cc6-49bf-ad4f-775fa1fe5699", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId/axerve_payments", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId", "axerve_payments" ], "variable": [ { "id": "63caf0fc-3d13-43e0-b8c3-00dbb7423027", "key": "axerveGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the axerve payments associated to the axerve gateway" }, "response": [ { "id": "76c2e498-dfbd-4106-928d-1071542b2050", "name": "The axerve_payments associated to the axerve gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId/axerve_payments", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId", "axerve_payments" ], "variable": [ { "key": "axerveGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-76c2e498-dfbd-4106-928d-1071542b2050" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-11325d1a-6cc6-49bf-ad4f-775fa1fe5699" } ], "id": "97b83174-93fc-4a1f-b099-65da003b32d6", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-97b83174-93fc-4a1f-b099-65da003b32d6" }, { "name": "Retrieve an axerve gateway", "id": "d577cdc6-2575-42ea-b3cf-6b72b0705ef7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId" ], "variable": [ { "id": "cb77022f-02b3-4c4b-819b-a1f3149410fe", "key": "axerveGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an axerve gateway" }, "response": [ { "id": "458b783c-d134-4ae1-bb77-cb5afcb62e26", "name": "The axerve gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId" ], "variable": [ { "key": "axerveGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"axerve_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"axerve_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-458b783c-d134-4ae1-bb77-cb5afcb62e26" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d577cdc6-2575-42ea-b3cf-6b72b0705ef7" }, { "name": "Update an axerve gateway", "id": "8b96b8a2-0258-4ce9-ba11-0f47be59a9f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"api_key\": \"\"\n },\n \"relationships\": {\n \"axerve_payments\": {\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId" ], "variable": [ { "id": "759b348c-6c34-4342-88eb-5a252e815767", "key": "axerveGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an axerve gateway" }, "response": [ { "id": "2fab015d-d780-4a58-8ed9-9b9818415e19", "name": "The updated axerve gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"api_key\": \"\"\n },\n \"relationships\": {\n \"axerve_payments\": {\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId" ], "variable": [ { "key": "axerveGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"axerve_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"axerve_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2fab015d-d780-4a58-8ed9-9b9818415e19" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8b96b8a2-0258-4ce9-ba11-0f47be59a9f7" }, { "name": "Delete an axerve gateway", "id": "2d0f47ea-22cc-4db3-a552-1f0ecdb5ac27", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId" ], "variable": [ { "id": "fa847ce5-5dd1-49c9-a72e-1ba579a5407c", "key": "axerveGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an axerve gateway" }, "response": [ { "id": "25369917-3f5c-4ee9-8a5c-c59038e5accf", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_gateways/:axerveGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways", ":axerveGatewayId" ], "variable": [ { "key": "axerveGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-25369917-3f5c-4ee9-8a5c-c59038e5accf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d0f47ea-22cc-4db3-a552-1f0ecdb5ac27" } ], "id": "a80f5dd8-f82e-4bf3-bb0e-e57442016cea", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-a80f5dd8-f82e-4bf3-bb0e-e57442016cea" }, { "name": "List all axerve gateways", "id": "791bd2ca-beed-416f-b64e-aabcb4e4145c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/axerve_gateways", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways" ] }, "description": "List all axerve gateways" }, "response": [ { "id": "4100674e-5549-4545-b939-a28790b8d505", "name": "A list of axerve gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_gateways", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"axerve_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"axerve_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"axerve_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"axerve_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4100674e-5549-4545-b939-a28790b8d505" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-791bd2ca-beed-416f-b64e-aabcb4e4145c" }, { "name": "Create an axerve gateway", "id": "ca26bcad-16a9-4660-ba9c-e07991daa8e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"login\": \"\",\n \"api_key\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"axerve_payments\": {\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_gateways", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways" ] }, "description": "Create an axerve gateway" }, "response": [ { "id": "730f6123-7623-4459-8e05-4a2c138e41e3", "name": "The created axerve gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"login\": \"\",\n \"api_key\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"axerve_payments\": {\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_gateways", "host": [ "{{baseUrl}}" ], "path": [ "axerve_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"axerve_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"login\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"axerve_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-730f6123-7623-4459-8e05-4a2c138e41e3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ca26bcad-16a9-4660-ba9c-e07991daa8e3" } ], "id": "5438be1c-fa63-4431-8b74-66c0a4ef0216", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-5438be1c-fa63-4431-8b74-66c0a4ef0216" }, { "name": "axerve_payments", "item": [ { "name": "{axervePaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the axerve payment", "id": "99dac587-392e-4903-a734-05e17dc4c9ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId", "order" ], "variable": [ { "id": "d1e492a5-f550-4377-83a6-fa9b96c3c27e", "key": "axervePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the axerve payment" }, "response": [ { "id": "03735d08-6dd6-4ec1-b176-d52f64fecb26", "name": "The order associated to the axerve payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId", "order" ], "variable": [ { "key": "axervePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-03735d08-6dd6-4ec1-b176-d52f64fecb26" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-99dac587-392e-4903-a734-05e17dc4c9ce" } ], "id": "2bbe2e2e-bfb2-4ff8-bcb9-31569a61557e", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-2bbe2e2e-bfb2-4ff8-bcb9-31569a61557e" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the axerve payment", "id": "a134c9a2-9119-48a8-a629-41b0784cbc34", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId", "payment_gateway" ], "variable": [ { "id": "f88cea22-8cdf-4ccc-a43d-9419f1d84a87", "key": "axervePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the axerve payment" }, "response": [ { "id": "8b6f89cf-43f5-4a78-b20a-fdc21a66b5fa", "name": "The payment_gateway associated to the axerve payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId", "payment_gateway" ], "variable": [ { "key": "axervePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8b6f89cf-43f5-4a78-b20a-fdc21a66b5fa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a134c9a2-9119-48a8-a629-41b0784cbc34" } ], "id": "6140895f-8b47-4fbb-84eb-b9d7ba7b1f32", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-6140895f-8b47-4fbb-84eb-b9d7ba7b1f32" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the axerve payment", "id": "2e8351e3-7605-46ca-af5b-0a152c091b32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId", "event_stores" ], "variable": [ { "id": "a4c9b988-7b9a-403f-a17e-1d75869274b6", "key": "axervePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the axerve payment" }, "response": [ { "id": "fa47c0a4-f9bd-4c5e-8917-c0bd8855c846", "name": "The event_stores associated to the axerve payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId", "event_stores" ], "variable": [ { "key": "axervePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa47c0a4-f9bd-4c5e-8917-c0bd8855c846" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e8351e3-7605-46ca-af5b-0a152c091b32" } ], "id": "de75c7ad-25fe-4e01-b1cd-1e199bfa0b28", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-de75c7ad-25fe-4e01-b1cd-1e199bfa0b28" }, { "name": "Retrieve an axerve payment", "id": "7736eb1c-7d63-4b01-9d76-4c667df4f0c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId" ], "variable": [ { "id": "5addda2e-dc1a-47a1-a01d-75c7aa7f3114", "key": "axervePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an axerve payment" }, "response": [ { "id": "82abc06e-6e0c-4882-9055-7aab766b7370", "name": "The axerve payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId" ], "variable": [ { "key": "axervePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"axerve_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"login\": \"\",\n \"return_url\": \"\",\n \"payment_request_data\": {},\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-82abc06e-6e0c-4882-9055-7aab766b7370" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7736eb1c-7d63-4b01-9d76-4c667df4f0c1" }, { "name": "Update an axerve payment", "id": "71c259f7-223d-40b6-93eb-61f9bbb32580", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"payment_request_data\": {},\n \"_update\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId" ], "variable": [ { "id": "bc5e5361-17f4-4d0d-9d6e-e0a70ac6f2fc", "key": "axervePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an axerve payment" }, "response": [ { "id": "f4297813-457d-431a-812a-536aed9f0d55", "name": "The updated axerve payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"payment_request_data\": {},\n \"_update\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId" ], "variable": [ { "key": "axervePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"axerve_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"login\": \"\",\n \"return_url\": \"\",\n \"payment_request_data\": {},\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f4297813-457d-431a-812a-536aed9f0d55" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-71c259f7-223d-40b6-93eb-61f9bbb32580" }, { "name": "Delete an axerve payment", "id": "22b6654b-13ab-42fe-b340-a755185ddb5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId" ], "variable": [ { "id": "6e323f3d-0a00-4cff-bec7-a852fe952ce7", "key": "axervePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an axerve payment" }, "response": [ { "id": "eba3f2a7-6083-4dd5-b653-7b8f91565104", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_payments/:axervePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments", ":axervePaymentId" ], "variable": [ { "key": "axervePaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-eba3f2a7-6083-4dd5-b653-7b8f91565104" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-22b6654b-13ab-42fe-b340-a755185ddb5f" } ], "id": "905b1efc-cbfa-4455-bdfa-22f2f7f00020", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-905b1efc-cbfa-4455-bdfa-22f2f7f00020" }, { "name": "List all axerve payments", "id": "c3887940-1d5d-43de-82c6-6e1b0e2fe606", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/axerve_payments", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments" ] }, "description": "List all axerve payments" }, "response": [ { "id": "afa02f78-ab7c-45e8-a5ed-eeac259249a1", "name": "A list of axerve payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/axerve_payments", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"axerve_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"login\": \"\",\n \"return_url\": \"\",\n \"payment_request_data\": {},\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"axerve_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"login\": \"\",\n \"return_url\": \"\",\n \"payment_request_data\": {},\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-afa02f78-ab7c-45e8-a5ed-eeac259249a1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c3887940-1d5d-43de-82c6-6e1b0e2fe606" }, { "name": "Create an axerve payment", "id": "1ce53e5d-96fb-4445-9559-dede856b80c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_payments\",\n \"attributes\": {\n \"return_url\": \"\",\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_payments", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments" ] }, "description": "Create an axerve payment" }, "response": [ { "id": "b815d060-1153-46b3-9c35-3ef4bfcac9da", "name": "The created axerve payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"axerve_payments\",\n \"attributes\": {\n \"return_url\": \"\",\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/axerve_payments", "host": [ "{{baseUrl}}" ], "path": [ "axerve_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"axerve_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"login\": \"\",\n \"return_url\": \"\",\n \"payment_request_data\": {},\n \"client_ip\": \"\",\n \"buyer_details\": {},\n \"request_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b815d060-1153-46b3-9c35-3ef4bfcac9da" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ce53e5d-96fb-4445-9559-dede856b80c0" } ], "id": "ace17c89-2c5a-446d-868c-69ebb4a3112f", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-ace17c89-2c5a-446d-868c-69ebb4a3112f" }, { "name": "bing_geocoders", "item": [ { "name": "{bingGeocoderId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the bing geocoder", "id": "daf79598-85b3-48c0-882a-4723125732c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/markets", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "markets" ], "variable": [ { "id": "f977802b-b01c-469d-8b23-e7b1ceddd308", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the bing geocoder" }, "response": [ { "id": "4c61ad49-1934-45b8-b955-ac1fa048b1f7", "name": "The markets associated to the bing geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/markets", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "markets" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4c61ad49-1934-45b8-b955-ac1fa048b1f7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-daf79598-85b3-48c0-882a-4723125732c4" } ], "id": "2ab11c17-6c1f-4cf1-b330-132ee14b29f1", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-2ab11c17-6c1f-4cf1-b330-132ee14b29f1" }, { "name": "addresses", "item": [ { "name": "Retrieve the addresses associated to the bing geocoder", "id": "cc768ce1-aab3-497a-acc9-b95b359d976e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "addresses" ], "variable": [ { "id": "caa4a0ff-10b5-4707-ace4-9f0bbf123923", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the addresses associated to the bing geocoder" }, "response": [ { "id": "c5e23dd7-06af-459e-88ff-96b6130418b2", "name": "The addresses associated to the bing geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "addresses" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c5e23dd7-06af-459e-88ff-96b6130418b2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cc768ce1-aab3-497a-acc9-b95b359d976e" } ], "id": "19dd6e21-5f80-4e99-bc55-6fd8cc8a29fd", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-19dd6e21-5f80-4e99-bc55-6fd8cc8a29fd" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the bing geocoder", "id": "41c2f55b-3c53-47cf-87ce-ce6bf0640643", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "attachments" ], "variable": [ { "id": "93632c46-24a0-4cd5-9fe5-64a163cf4321", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the bing geocoder" }, "response": [ { "id": "4d879afa-61cf-4f2e-a260-064b3e582a2a", "name": "The attachments associated to the bing geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "attachments" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4d879afa-61cf-4f2e-a260-064b3e582a2a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-41c2f55b-3c53-47cf-87ce-ce6bf0640643" } ], "id": "e3bdcfee-0cfc-4e38-9a65-068e8ce43f11", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-e3bdcfee-0cfc-4e38-9a65-068e8ce43f11" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the bing geocoder", "id": "9761b849-0070-4031-8d81-6d82e717ffe7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "event_stores" ], "variable": [ { "id": "be36bd30-8acd-4af3-8378-690619200e93", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the bing geocoder" }, "response": [ { "id": "4917a3ac-9b5e-48ed-b2a1-ea8d0c566ac0", "name": "The event_stores associated to the bing geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId", "event_stores" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4917a3ac-9b5e-48ed-b2a1-ea8d0c566ac0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9761b849-0070-4031-8d81-6d82e717ffe7" } ], "id": "fd39a0e5-7e23-4041-b702-c271246a3349", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-fd39a0e5-7e23-4041-b702-c271246a3349" }, { "name": "Retrieve a bing geocoder", "id": "e4247c9f-2dff-4882-b88b-4d9a68b6bba8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId" ], "variable": [ { "id": "22b6f4fa-4760-4f63-b0f5-a4229d8ae14c", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a bing geocoder" }, "response": [ { "id": "49cee7fd-fe2a-417d-9875-f93bf2e35bee", "name": "The bing geocoder object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"bing_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"bing_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-49cee7fd-fe2a-417d-9875-f93bf2e35bee" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e4247c9f-2dff-4882-b88b-4d9a68b6bba8" }, { "name": "Update a bing geocoder", "id": "a210af8a-e7c4-40e7-8252-06507d5acdba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bing_geocoders\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"key\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId" ], "variable": [ { "id": "ee55ea8d-438f-4687-9f92-75ec03faffc5", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a bing geocoder" }, "response": [ { "id": "65680fd0-4183-462a-8c11-6b9e4189a19c", "name": "The updated bing geocoder object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bing_geocoders\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"key\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"bing_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"bing_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-65680fd0-4183-462a-8c11-6b9e4189a19c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a210af8a-e7c4-40e7-8252-06507d5acdba" }, { "name": "Delete a bing geocoder", "id": "fe0c59bf-22f9-4be3-b5ac-0d6ff5472ffb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId" ], "variable": [ { "id": "2c4584a9-4ad1-436c-85ba-45f37fe6a6c5", "key": "bingGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a bing geocoder" }, "response": [ { "id": "dec00af5-f832-4601-8cb8-72df450d1cd9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders/:bingGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders", ":bingGeocoderId" ], "variable": [ { "key": "bingGeocoderId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dec00af5-f832-4601-8cb8-72df450d1cd9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fe0c59bf-22f9-4be3-b5ac-0d6ff5472ffb" } ], "id": "6a62f528-2019-4e01-9d5c-862fc8e36d60", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-6a62f528-2019-4e01-9d5c-862fc8e36d60" }, { "name": "List all bing geocoders", "id": "22ca7906-9361-402e-8454-bf2dd4bb9e41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/bing_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders" ] }, "description": "List all bing geocoders" }, "response": [ { "id": "754b5bd5-cd0f-47c3-bbf4-64218884df85", "name": "A list of bing geocoder objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bing_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"bing_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"bing_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-754b5bd5-cd0f-47c3-bbf4-64218884df85" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-22ca7906-9361-402e-8454-bf2dd4bb9e41" }, { "name": "Create a bing geocoder", "id": "ad286787-6a37-4ce4-9c05-81e09f3e3069", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bing_geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bing_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders" ] }, "description": "Create a bing geocoder" }, "response": [ { "id": "19ab1670-ba55-425a-96ab-e94ef988424f", "name": "The created bing geocoder object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bing_geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bing_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "bing_geocoders" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"bing_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"bing_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-19ab1670-ba55-425a-96ab-e94ef988424f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad286787-6a37-4ce4-9c05-81e09f3e3069" } ], "id": "ab59cb95-1ca0-46ae-aec0-b20c1193af82", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-ab59cb95-1ca0-46ae-aec0-b20c1193af82" }, { "name": "braintree_gateways", "item": [ { "name": "{braintreeGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the braintree gateway", "id": "07e56ddd-68d9-48ae-9508-fa2566aec191", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId", "payment_methods" ], "variable": [ { "id": "fa93079a-912c-43da-9a42-d14de4b61b82", "key": "braintreeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the braintree gateway" }, "response": [ { "id": "b1ef8242-163c-4fd5-a3ac-e7b2dc0847c4", "name": "The payment_methods associated to the braintree gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId", "payment_methods" ], "variable": [ { "key": "braintreeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b1ef8242-163c-4fd5-a3ac-e7b2dc0847c4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07e56ddd-68d9-48ae-9508-fa2566aec191" } ], "id": "976c7166-48bd-4ec6-9609-e1dc2378301a", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-976c7166-48bd-4ec6-9609-e1dc2378301a" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the braintree gateway", "id": "19cff0a2-c95c-457f-8a1e-6a735145a1dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId", "event_stores" ], "variable": [ { "id": "50c71bd7-c682-4ff5-8ed9-5337093c5ed9", "key": "braintreeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the braintree gateway" }, "response": [ { "id": "c86cb3ba-dde4-4ca0-baff-f8065a249966", "name": "The event_stores associated to the braintree gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId", "event_stores" ], "variable": [ { "key": "braintreeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c86cb3ba-dde4-4ca0-baff-f8065a249966" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19cff0a2-c95c-457f-8a1e-6a735145a1dc" } ], "id": "5a2baf96-5a53-43cc-8aab-b3e6a39ab6b2", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-5a2baf96-5a53-43cc-8aab-b3e6a39ab6b2" }, { "name": "braintree_payments", "item": [ { "name": "Retrieve the braintree payments associated to the braintree gateway", "id": "09695102-6c59-4631-956b-0116952714dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId/braintree_payments", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId", "braintree_payments" ], "variable": [ { "id": "6c442ea1-56c9-4dc1-9dca-a25e8adf6360", "key": "braintreeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the braintree payments associated to the braintree gateway" }, "response": [ { "id": "307f7c8e-f452-4dff-a1e5-1c4c5217513b", "name": "The braintree_payments associated to the braintree gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId/braintree_payments", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId", "braintree_payments" ], "variable": [ { "key": "braintreeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-307f7c8e-f452-4dff-a1e5-1c4c5217513b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-09695102-6c59-4631-956b-0116952714dd" } ], "id": "36ed96f3-63b6-451e-8bdd-d43edffa3514", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-36ed96f3-63b6-451e-8bdd-d43edffa3514" }, { "name": "Retrieve a braintree gateway", "id": "a290701a-d957-423d-993c-b3a393426e82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId" ], "variable": [ { "id": "31a478d9-3fc0-4747-8ab0-cdda8b422fd5", "key": "braintreeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a braintree gateway" }, "response": [ { "id": "b13a4fb4-9d84-483d-a347-ce5908fd63b5", "name": "The braintree gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId" ], "variable": [ { "key": "braintreeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"braintree_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"braintree_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b13a4fb4-9d84-483d-a347-ce5908fd63b5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a290701a-d957-423d-993c-b3a393426e82" }, { "name": "Update a braintree gateway", "id": "ed009f10-8227-4469-bd82-e37fa57ecb0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"merchant_account_id\": \"\",\n \"merchant_id\": \"\",\n \"public_key\": \"\",\n \"private_key\": \"\",\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\"\n },\n \"relationships\": {\n \"braintree_payments\": {\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId" ], "variable": [ { "id": "68bf44d6-0a2c-451f-a894-d0168646c9d9", "key": "braintreeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a braintree gateway" }, "response": [ { "id": "24a5e625-31d1-434b-92a8-76f885f13847", "name": "The updated braintree gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"merchant_account_id\": \"\",\n \"merchant_id\": \"\",\n \"public_key\": \"\",\n \"private_key\": \"\",\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\"\n },\n \"relationships\": {\n \"braintree_payments\": {\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId" ], "variable": [ { "key": "braintreeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"braintree_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"braintree_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-24a5e625-31d1-434b-92a8-76f885f13847" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ed009f10-8227-4469-bd82-e37fa57ecb0b" }, { "name": "Delete a braintree gateway", "id": "5d77fd6c-5e3e-46b6-9ce3-32c3d2265c4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId" ], "variable": [ { "id": "f855292b-9e08-45d9-bbaa-744b756fe1d7", "key": "braintreeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a braintree gateway" }, "response": [ { "id": "6c25de64-54fe-41e2-9b75-9e4fc181d003", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_gateways/:braintreeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways", ":braintreeGatewayId" ], "variable": [ { "key": "braintreeGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6c25de64-54fe-41e2-9b75-9e4fc181d003" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5d77fd6c-5e3e-46b6-9ce3-32c3d2265c4c" } ], "id": "8ad3d303-03dd-48cb-8100-11436b847fa1", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8ad3d303-03dd-48cb-8100-11436b847fa1" }, { "name": "List all braintree gateways", "id": "79709a5e-37cc-472b-84aa-8e59607eba4e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/braintree_gateways", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways" ] }, "description": "List all braintree gateways" }, "response": [ { "id": "31d6af5a-cced-44aa-bbd4-479fec3c4caa", "name": "A list of braintree gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_gateways", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"braintree_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"braintree_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"braintree_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"braintree_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-31d6af5a-cced-44aa-bbd4-479fec3c4caa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-79709a5e-37cc-472b-84aa-8e59607eba4e" }, { "name": "Create a braintree gateway", "id": "d2e46489-b735-42d2-a1e7-bd9261118b50", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"merchant_account_id\": \"\",\n \"merchant_id\": \"\",\n \"public_key\": \"\",\n \"private_key\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\"\n },\n \"relationships\": {\n \"braintree_payments\": {\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_gateways", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways" ] }, "description": "Create a braintree gateway" }, "response": [ { "id": "376d7438-d9d5-441f-8797-0bebc616e370", "name": "The created braintree gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"merchant_account_id\": \"\",\n \"merchant_id\": \"\",\n \"public_key\": \"\",\n \"private_key\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\"\n },\n \"relationships\": {\n \"braintree_payments\": {\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_gateways", "host": [ "{{baseUrl}}" ], "path": [ "braintree_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"braintree_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"descriptor_name\": \"\",\n \"descriptor_phone\": \"\",\n \"descriptor_url\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"braintree_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-376d7438-d9d5-441f-8797-0bebc616e370" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d2e46489-b735-42d2-a1e7-bd9261118b50" } ], "id": "27d4a1c5-554c-41e6-8e1d-5e099963406c", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-27d4a1c5-554c-41e6-8e1d-5e099963406c" }, { "name": "braintree_payments", "item": [ { "name": "{braintreePaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the braintree payment", "id": "deb4bad4-9219-432f-91fa-1f22d48d3e4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId", "order" ], "variable": [ { "id": "c530a164-ba55-4756-b15c-123a756bfe47", "key": "braintreePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the braintree payment" }, "response": [ { "id": "6bd2a855-c4d6-4971-b7ba-7288a02c9eb8", "name": "The order associated to the braintree payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId", "order" ], "variable": [ { "key": "braintreePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6bd2a855-c4d6-4971-b7ba-7288a02c9eb8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-deb4bad4-9219-432f-91fa-1f22d48d3e4d" } ], "id": "54aaa41c-4f81-4751-8fb0-eb9e93265fa4", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-54aaa41c-4f81-4751-8fb0-eb9e93265fa4" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the braintree payment", "id": "cd2f2e8f-fa3a-4976-b760-13cb80675fa5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId", "payment_gateway" ], "variable": [ { "id": "46ad8a53-8814-4480-99fb-c8882d051ace", "key": "braintreePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the braintree payment" }, "response": [ { "id": "7b9b03a8-0026-4352-8c14-9fedfc6ad72b", "name": "The payment_gateway associated to the braintree payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId", "payment_gateway" ], "variable": [ { "key": "braintreePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7b9b03a8-0026-4352-8c14-9fedfc6ad72b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cd2f2e8f-fa3a-4976-b760-13cb80675fa5" } ], "id": "b003f98d-c9c3-4027-91aa-b1ec57ae4289", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-b003f98d-c9c3-4027-91aa-b1ec57ae4289" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the braintree payment", "id": "0340131f-9e9b-4d73-91d0-01d79ee1ee31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId", "event_stores" ], "variable": [ { "id": "6339a684-0712-4b8d-adcf-e74a70e3f64c", "key": "braintreePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the braintree payment" }, "response": [ { "id": "4f53100d-bef0-4925-b233-4c9f651aad3f", "name": "The event_stores associated to the braintree payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId", "event_stores" ], "variable": [ { "key": "braintreePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4f53100d-bef0-4925-b233-4c9f651aad3f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0340131f-9e9b-4d73-91d0-01d79ee1ee31" } ], "id": "fc83eca5-fcb6-49ca-b991-79d7a17d8788", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-fc83eca5-fcb6-49ca-b991-79d7a17d8788" }, { "name": "Retrieve a braintree payment", "id": "3090ce3f-9b48-4abc-b1bf-c3b2e8654a5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId" ], "variable": [ { "id": "484b8dea-f5b4-4973-8a66-520865e273e0", "key": "braintreePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a braintree payment" }, "response": [ { "id": "20371e9e-4523-4471-9596-9f9377f28d87", "name": "The braintree payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId" ], "variable": [ { "key": "braintreePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"braintree_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"client_token\": \"\",\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-20371e9e-4523-4471-9596-9f9377f28d87" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3090ce3f-9b48-4abc-b1bf-c3b2e8654a5f" }, { "name": "Update a braintree payment", "id": "92fd9032-31f7-4a36-886a-3cc8fe9ff550", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId" ], "variable": [ { "id": "cf175fbe-bc5e-4660-9cf9-a001fb99d947", "key": "braintreePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a braintree payment" }, "response": [ { "id": "bbcd5ab8-3da0-4323-84f8-155cece3eca8", "name": "The updated braintree payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId" ], "variable": [ { "key": "braintreePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"braintree_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"client_token\": \"\",\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bbcd5ab8-3da0-4323-84f8-155cece3eca8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-92fd9032-31f7-4a36-886a-3cc8fe9ff550" }, { "name": "Delete a braintree payment", "id": "bb75c7bd-d487-4b09-a850-8e157e180ede", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId" ], "variable": [ { "id": "427d5411-d2e6-4257-ac40-aa066787b0a8", "key": "braintreePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a braintree payment" }, "response": [ { "id": "c23637fa-1a02-45b5-a750-9b4ebdfcd186", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_payments/:braintreePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments", ":braintreePaymentId" ], "variable": [ { "key": "braintreePaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c23637fa-1a02-45b5-a750-9b4ebdfcd186" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bb75c7bd-d487-4b09-a850-8e157e180ede" } ], "id": "277b8549-8e9d-43c6-a1d2-bcaa96e36fab", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-277b8549-8e9d-43c6-a1d2-bcaa96e36fab" }, { "name": "List all braintree payments", "id": "9dddfb05-2bb6-42eb-a50b-7ee3cd64634e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/braintree_payments", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments" ] }, "description": "List all braintree payments" }, "response": [ { "id": "26666775-fe1d-4ae0-8223-b63a33925406", "name": "A list of braintree payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/braintree_payments", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"braintree_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"client_token\": \"\",\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"braintree_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"client_token\": \"\",\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-26666775-fe1d-4ae0-8223-b63a33925406" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9dddfb05-2bb6-42eb-a50b-7ee3cd64634e" }, { "name": "Create a braintree payment", "id": "8e67a0a9-18cd-4a84-a077-a243e60b365f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_payments\",\n \"attributes\": {\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_payments", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments" ] }, "description": "Create a braintree payment" }, "response": [ { "id": "fc57b04c-84b7-4252-99cd-0b68898e17bd", "name": "The created braintree payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"braintree_payments\",\n \"attributes\": {\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/braintree_payments", "host": [ "{{baseUrl}}" ], "path": [ "braintree_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"braintree_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"client_token\": \"\",\n \"payment_method_nonce\": \"\",\n \"payment_id\": \"\",\n \"local\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fc57b04c-84b7-4252-99cd-0b68898e17bd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8e67a0a9-18cd-4a84-a077-a243e60b365f" } ], "id": "ab282e9e-5d0d-4d4c-813d-3de9b5250c9e", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-ab282e9e-5d0d-4d4c-813d-3de9b5250c9e" }, { "name": "bundles", "item": [ { "name": "{bundleId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the bundle", "id": "34f82933-eb37-42d3-aad5-df53fbc8ed89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/market", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "market" ], "variable": [ { "id": "38ecd2e8-eb02-481b-a427-6333bc58ce31", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the bundle" }, "response": [ { "id": "300b4ea0-6a39-4366-9064-3df4d3335914", "name": "The market associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/market", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "market" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-300b4ea0-6a39-4366-9064-3df4d3335914" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-34f82933-eb37-42d3-aad5-df53fbc8ed89" } ], "id": "eac95f45-c186-4662-9c05-08ca2ad32aff", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-eac95f45-c186-4662-9c05-08ca2ad32aff" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the bundle", "id": "5ee6d1b2-205b-4d28-9b68-ebf068e7ac33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "sku_list" ], "variable": [ { "id": "33ebe80c-ba63-44a0-acdf-291b979645dc", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the bundle" }, "response": [ { "id": "6161a350-5cf8-461c-8b1a-575e732e8cf0", "name": "The sku_list associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "sku_list" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6161a350-5cf8-461c-8b1a-575e732e8cf0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5ee6d1b2-205b-4d28-9b68-ebf068e7ac33" } ], "id": "3ecdf89d-47ca-42af-8e0b-9f6cd79494f5", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3ecdf89d-47ca-42af-8e0b-9f6cd79494f5" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the bundle", "id": "290181bf-0e39-45b2-8c25-2ebe3e3ca87d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/skus", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "skus" ], "variable": [ { "id": "96b42af2-88c8-4776-8437-cac1f7b87f9b", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the bundle" }, "response": [ { "id": "b772051a-3b49-4844-9604-196d34c097b5", "name": "The skus associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/skus", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "skus" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b772051a-3b49-4844-9604-196d34c097b5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-290181bf-0e39-45b2-8c25-2ebe3e3ca87d" } ], "id": "e91866b7-cb7b-410d-83dd-80156af6a931", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-e91866b7-cb7b-410d-83dd-80156af6a931" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the bundle", "id": "6613878f-d684-458a-bb35-54400ee79e5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "attachments" ], "variable": [ { "id": "53e2b3fa-47b7-4fe3-996c-71179ffd0928", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the bundle" }, "response": [ { "id": "d554e8af-dd46-4e06-98bc-c5e979b9a21b", "name": "The attachments associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "attachments" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d554e8af-dd46-4e06-98bc-c5e979b9a21b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6613878f-d684-458a-bb35-54400ee79e5c" } ], "id": "2ffcbfcb-2e99-4622-81a4-4d6511a7e4a2", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-2ffcbfcb-2e99-4622-81a4-4d6511a7e4a2" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the bundle", "id": "fcbc6191-cbfb-46e0-bcb6-e7a3594bb69c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/events", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "events" ], "variable": [ { "id": "02431902-dcc0-43c2-b427-21942e4b336f", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the bundle" }, "response": [ { "id": "c8cdc1a6-aa02-48f0-922f-25c9fad808e5", "name": "The events associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/events", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "events" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c8cdc1a6-aa02-48f0-922f-25c9fad808e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fcbc6191-cbfb-46e0-bcb6-e7a3594bb69c" } ], "id": "3f250be5-5385-4a7a-9ecb-3ec711a39dad", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3f250be5-5385-4a7a-9ecb-3ec711a39dad" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the bundle", "id": "8b74bfaa-2708-443c-9073-80f5b266fea0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/tags", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "tags" ], "variable": [ { "id": "824b3d00-a8a8-44ff-8be0-76f7f5740653", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the bundle" }, "response": [ { "id": "4b6ab39c-338a-4aa0-8ab6-cbeb2d5de41c", "name": "The tags associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/tags", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "tags" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4b6ab39c-338a-4aa0-8ab6-cbeb2d5de41c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8b74bfaa-2708-443c-9073-80f5b266fea0" } ], "id": "5845dee5-31a8-4a9b-874d-f968f5300ace", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-5845dee5-31a8-4a9b-874d-f968f5300ace" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the bundle", "id": "71aa5186-52e4-49df-9627-cfcfe749b404", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "event_stores" ], "variable": [ { "id": "59b44141-1ce0-45c1-8af9-123340b86560", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the bundle" }, "response": [ { "id": "b6fcb7e0-d822-413c-ad1b-5d6a65ef208d", "name": "The event_stores associated to the bundle", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId", "event_stores" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b6fcb7e0-d822-413c-ad1b-5d6a65ef208d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-71aa5186-52e4-49df-9627-cfcfe749b404" } ], "id": "3e3b521c-da22-4db9-b9ca-d699d08a45d5", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3e3b521c-da22-4db9-b9ca-d699d08a45d5" }, { "name": "Retrieve a bundle", "id": "1b6fc8f8-21f9-49ad-b99f-91439a3d5bb1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId" ], "variable": [ { "id": "3e45c502-b8ad-45fb-984f-df492d5dbbfa", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a bundle" }, "response": [ { "id": "a03a845e-2eed-4a9a-b907-8aeb7619f9a5", "name": "The bundle object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"bundles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"skus_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a03a845e-2eed-4a9a-b907-8aeb7619f9a5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1b6fc8f8-21f9-49ad-b99f-91439a3d5bb1" }, { "name": "Update a bundle", "id": "c0bb2398-abf8-4032-bec9-96050f3e7738", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"price_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"_compute_price_amount\": \"\",\n \"_compute_compare_at_amount\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bundles/:bundleId", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId" ], "variable": [ { "id": "1b659cc4-389e-47a0-af0f-570721ef1e34", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a bundle" }, "response": [ { "id": "b56e93d4-1e71-4b61-a8fe-d6571178db51", "name": "The updated bundle object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"price_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"_compute_price_amount\": \"\",\n \"_compute_compare_at_amount\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bundles/:bundleId", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId" ], "variable": [ { "key": "bundleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"bundles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"skus_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b56e93d4-1e71-4b61-a8fe-d6571178db51" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c0bb2398-abf8-4032-bec9-96050f3e7738" }, { "name": "Delete a bundle", "id": "de8a9110-c36c-45f1-aac6-f8eaebb1ca3a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/bundles/:bundleId", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId" ], "variable": [ { "id": "10cc2ce9-1a0c-41ad-b4f5-d9ea587348d9", "key": "bundleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a bundle" }, "response": [ { "id": "359cc8ec-1cf8-4202-818a-1859691599db", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles/:bundleId", "host": [ "{{baseUrl}}" ], "path": [ "bundles", ":bundleId" ], "variable": [ { "key": "bundleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-359cc8ec-1cf8-4202-818a-1859691599db" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-de8a9110-c36c-45f1-aac6-f8eaebb1ca3a" } ], "id": "b45c25ca-c99c-4bf7-994c-efd3b08568c9", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-b45c25ca-c99c-4bf7-994c-efd3b08568c9" }, { "name": "List all bundles", "id": "b331dc5f-f960-43a7-8fc3-19e7b5ad1525", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/bundles", "host": [ "{{baseUrl}}" ], "path": [ "bundles" ] }, "description": "List all bundles" }, "response": [ { "id": "ac7c0205-2cd4-44d7-b7e6-ce4fa0ef5c33", "name": "A list of bundle objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/bundles", "host": [ "{{baseUrl}}" ], "path": [ "bundles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"bundles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"skus_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"bundles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"skus_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ac7c0205-2cd4-44d7-b7e6-ce4fa0ef5c33" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b331dc5f-f960-43a7-8fc3-19e7b5ad1525" }, { "name": "Create a bundle", "id": "aeede10a-4b13-424b-bad2-98b4c04ea577", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bundles\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"price_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"_compute_price_amount\": \"\",\n \"_compute_compare_at_amount\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bundles", "host": [ "{{baseUrl}}" ], "path": [ "bundles" ] }, "description": "Create a bundle" }, "response": [ { "id": "c9edf50a-8c24-4954-9236-cf48576e7e66", "name": "The created bundle object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"bundles\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"price_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"_compute_price_amount\": \"\",\n \"_compute_compare_at_amount\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bundles", "host": [ "{{baseUrl}}" ], "path": [ "bundles" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"bundles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"skus_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c9edf50a-8c24-4954-9236-cf48576e7e66" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-aeede10a-4b13-424b-bad2-98b4c04ea577" } ], "id": "565731c5-b0bd-49e1-ad6c-1f27776950fa", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-565731c5-b0bd-49e1-ad6c-1f27776950fa" }, { "name": "buy_x_pay_y_promotions", "item": [ { "name": "{buyXPayYPromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the buy x pay y promotion", "id": "09e23f59-20fd-4bb9-8270-57b4a257eab3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "market" ], "variable": [ { "id": "312a738f-9422-4317-9735-67641397baa0", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the buy x pay y promotion" }, "response": [ { "id": "3aaab039-adfa-4531-a4ef-5f0b9c72c31f", "name": "The market associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "market" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3aaab039-adfa-4531-a4ef-5f0b9c72c31f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-09e23f59-20fd-4bb9-8270-57b4a257eab3" } ], "id": "0973382f-886b-442f-8c65-ebdfd9302fa9", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-0973382f-886b-442f-8c65-ebdfd9302fa9" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the buy x pay y promotion", "id": "3ac38fc2-0a86-49c0-8a9b-0030545ad7f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "e7377098-7028-438d-9d8b-1dd5c322d06e", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the buy x pay y promotion" }, "response": [ { "id": "530f6a0b-c597-4091-8ef3-61c8b7f12eed", "name": "The order_amount_promotion_rule associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-530f6a0b-c597-4091-8ef3-61c8b7f12eed" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3ac38fc2-0a86-49c0-8a9b-0030545ad7f5" } ], "id": "59cbacaa-30c0-4b49-b64a-1b2cbd61c734", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-59cbacaa-30c0-4b49-b64a-1b2cbd61c734" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the buy x pay y promotion", "id": "d08ee98d-8783-42aa-8490-763877050edf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "10defe61-84eb-4f9a-ba09-13cc2077e4f7", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the buy x pay y promotion" }, "response": [ { "id": "703125d2-eec0-4980-8485-b0703fbb9e7a", "name": "The sku_list_promotion_rule associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-703125d2-eec0-4980-8485-b0703fbb9e7a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d08ee98d-8783-42aa-8490-763877050edf" } ], "id": "140c5c4f-c4f3-4dfd-94d6-e077a2d4d648", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-140c5c4f-c4f3-4dfd-94d6-e077a2d4d648" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the buy x pay y promotion", "id": "c15cca0e-9c90-4010-bf82-6df6f0e44a87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "de21c2c8-fc1c-40a9-abe9-6a8793cc6365", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the buy x pay y promotion" }, "response": [ { "id": "aebbd833-d1d7-4ec1-9562-9b42cd2958dd", "name": "The coupon_codes_promotion_rule associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aebbd833-d1d7-4ec1-9562-9b42cd2958dd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c15cca0e-9c90-4010-bf82-6df6f0e44a87" } ], "id": "0f5b9572-91b1-4f0a-8191-721b70f4fc94", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-0f5b9572-91b1-4f0a-8191-721b70f4fc94" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the buy x pay y promotion", "id": "582f3a57-c5e2-48a2-a910-356a84ffda5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "custom_promotion_rule" ], "variable": [ { "id": "db6b99b6-a956-4cfc-b6ad-12726bb6e055", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the buy x pay y promotion" }, "response": [ { "id": "eb7fd446-3710-42a8-a67e-92bf5deba4a9", "name": "The custom_promotion_rule associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "custom_promotion_rule" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-eb7fd446-3710-42a8-a67e-92bf5deba4a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-582f3a57-c5e2-48a2-a910-356a84ffda5f" } ], "id": "f0440996-a903-4aa1-9cac-8ee7c6a93b76", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f0440996-a903-4aa1-9cac-8ee7c6a93b76" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the buy x pay y promotion", "id": "ad332da8-1f16-4169-9cbe-e189028ac3e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "sku_list" ], "variable": [ { "id": "93062877-f4a6-428f-af0e-f33759a1189e", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the buy x pay y promotion" }, "response": [ { "id": "bae74ae6-facb-4815-8efe-3cdb68d869b2", "name": "The sku_list associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "sku_list" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bae74ae6-facb-4815-8efe-3cdb68d869b2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad332da8-1f16-4169-9cbe-e189028ac3e6" } ], "id": "93890554-a863-4366-9094-e75fe5b6d39e", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-93890554-a863-4366-9094-e75fe5b6d39e" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the buy x pay y promotion", "id": "149349fb-d13f-48ae-9925-b14db5642cd2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "coupons" ], "variable": [ { "id": "b4acce25-3ff8-4e1c-b52f-c45fa17df0b1", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the buy x pay y promotion" }, "response": [ { "id": "e49edf0b-4e49-474b-a2d5-ca36eeef6669", "name": "The coupons associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "coupons" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e49edf0b-4e49-474b-a2d5-ca36eeef6669" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-149349fb-d13f-48ae-9925-b14db5642cd2" } ], "id": "6c139c04-c55b-41be-a349-d88895ab2144", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-6c139c04-c55b-41be-a349-d88895ab2144" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the buy x pay y promotion", "id": "3149d2cf-d06f-4494-a088-07902bcb536e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "attachments" ], "variable": [ { "id": "d16c1b8c-e677-4763-8d52-bedb35505333", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the buy x pay y promotion" }, "response": [ { "id": "311fb9f8-62ae-433c-b9f6-7251eeb43ec0", "name": "The attachments associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "attachments" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-311fb9f8-62ae-433c-b9f6-7251eeb43ec0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3149d2cf-d06f-4494-a088-07902bcb536e" } ], "id": "b921e2fd-55ab-41ab-a123-e3618c4b553f", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-b921e2fd-55ab-41ab-a123-e3618c4b553f" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the buy x pay y promotion", "id": "ba4ea86c-fb56-4af9-8723-4d52dc19d47f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "events" ], "variable": [ { "id": "750d16fb-ec7f-46b3-ad51-2423bdb94558", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the buy x pay y promotion" }, "response": [ { "id": "69b2b167-56cf-4ab2-9f4d-4657acb98ddb", "name": "The events associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "events" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-69b2b167-56cf-4ab2-9f4d-4657acb98ddb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba4ea86c-fb56-4af9-8723-4d52dc19d47f" } ], "id": "f6aeed05-c0b0-449e-aa72-7d6cb1004bc6", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f6aeed05-c0b0-449e-aa72-7d6cb1004bc6" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the buy x pay y promotion", "id": "6f3e9b05-7e55-444c-9385-595e10bdd2dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "tags" ], "variable": [ { "id": "70bf42e4-69f9-4062-ac5a-ef6a7b5a1db7", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the buy x pay y promotion" }, "response": [ { "id": "b76f1c67-0864-4090-9fb0-aac0a5419f30", "name": "The tags associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "tags" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b76f1c67-0864-4090-9fb0-aac0a5419f30" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f3e9b05-7e55-444c-9385-595e10bdd2dc" } ], "id": "9297a9e5-f6d0-47c0-8a55-b9ac8d70e4dc", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-9297a9e5-f6d0-47c0-8a55-b9ac8d70e4dc" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the buy x pay y promotion", "id": "909290b4-198a-4f2b-b4a8-427f628fb780", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "event_stores" ], "variable": [ { "id": "739e9e6c-5e10-4257-8ada-4957b4ce1914", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the buy x pay y promotion" }, "response": [ { "id": "6c73b429-6fe4-4ae1-82cb-cde14e59a9bb", "name": "The event_stores associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "event_stores" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6c73b429-6fe4-4ae1-82cb-cde14e59a9bb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-909290b4-198a-4f2b-b4a8-427f628fb780" } ], "id": "2d9e7612-6060-476c-8880-3f87ac609e13", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-2d9e7612-6060-476c-8880-3f87ac609e13" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the buy x pay y promotion", "id": "22620713-a88f-4058-9716-66ea100384cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "skus" ], "variable": [ { "id": "f936fb4e-9172-4eab-84e2-dbb01bcd46cc", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the buy x pay y promotion" }, "response": [ { "id": "6be75bd0-da9f-4241-a4f9-22195510afe7", "name": "The skus associated to the buy x pay y promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId", "skus" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6be75bd0-da9f-4241-a4f9-22195510afe7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-22620713-a88f-4058-9716-66ea100384cc" } ], "id": "34ce28f1-31d8-4476-aeb0-22648b0d1abf", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-34ce28f1-31d8-4476-aeb0-22648b0d1abf" }, { "name": "Retrieve a buy x pay y promotion", "id": "60ad89a8-cd5e-4ea6-9383-b40425c1604e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId" ], "variable": [ { "id": "de0f0902-387d-4ba0-b09d-49826df17c38", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a buy x pay y promotion" }, "response": [ { "id": "e9c637d1-1c1e-448d-aa4c-9efb285004ce", "name": "The buy x pay y promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e9c637d1-1c1e-448d-aa4c-9efb285004ce" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-60ad89a8-cd5e-4ea6-9383-b40425c1604e" }, { "name": "Update a buy x pay y promotion", "id": "e9472692-0cc3-4797-b932-f4b783fe9cb5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"buy_x_pay_y_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId" ], "variable": [ { "id": "e8024089-74ee-48c9-8928-68cd8783897e", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a buy x pay y promotion" }, "response": [ { "id": "85cd2e91-ec24-4abe-bacf-aebada016949", "name": "The updated buy x pay y promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"buy_x_pay_y_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-85cd2e91-ec24-4abe-bacf-aebada016949" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e9472692-0cc3-4797-b932-f4b783fe9cb5" }, { "name": "Delete a buy x pay y promotion", "id": "f658bdbc-b29a-4c21-8ba8-e0566e6aeb20", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId" ], "variable": [ { "id": "8e94933c-279e-41aa-9972-3a0e85abef44", "key": "buyXPayYPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a buy x pay y promotion" }, "response": [ { "id": "4f8d8f1f-9b12-4744-9a51-33ea5069b6ae", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions/:buyXPayYPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions", ":buyXPayYPromotionId" ], "variable": [ { "key": "buyXPayYPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4f8d8f1f-9b12-4744-9a51-33ea5069b6ae" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f658bdbc-b29a-4c21-8ba8-e0566e6aeb20" } ], "id": "3c2e4685-d91f-46bf-a4a7-0f3e6d210816", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3c2e4685-d91f-46bf-a4a7-0f3e6d210816" }, { "name": "List all buy x pay y promotions", "id": "e625854a-cca3-4918-8c50-c75db705ece6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions" ] }, "description": "List all buy x pay y promotions" }, "response": [ { "id": "be41098d-2c17-4cb4-a32e-d6d75a3c10eb", "name": "A list of buy x pay y promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-be41098d-2c17-4cb4-a32e-d6d75a3c10eb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e625854a-cca3-4918-8c50-c75db705ece6" }, { "name": "Create a buy x pay y promotion", "id": "eed0ae98-549c-4a5f-8c5b-8231f93bc3c6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"buy_x_pay_y_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions" ] }, "description": "Create a buy x pay y promotion" }, "response": [ { "id": "cbdc2e2d-7a4c-497a-b263-caf0c85a8c0a", "name": "The created buy x pay y promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"buy_x_pay_y_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/buy_x_pay_y_promotions", "host": [ "{{baseUrl}}" ], "path": [ "buy_x_pay_y_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"x\": \"\",\n \"y\": \"\",\n \"cheapest_free\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cbdc2e2d-7a4c-497a-b263-caf0c85a8c0a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eed0ae98-549c-4a5f-8c5b-8231f93bc3c6" } ], "id": "7f7d4f6e-bd98-4059-a1a2-ed909f57af61", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7f7d4f6e-bd98-4059-a1a2-ed909f57af61" }, { "name": "captures", "item": [ { "name": "{captureId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the capture", "id": "e5ece85a-c12a-4b6c-aca7-ea888b3e8d23", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/order", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "order" ], "variable": [ { "id": "ae00257d-5082-455b-bfc3-b04af2309a16", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the capture" }, "response": [ { "id": "fa982fe3-ade1-4ca5-be86-9398e140b2c8", "name": "The order associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/order", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "order" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa982fe3-ade1-4ca5-be86-9398e140b2c8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5ece85a-c12a-4b6c-aca7-ea888b3e8d23" } ], "id": "1f131dca-d6d5-4d78-a8a7-0b8a3678fe43", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-1f131dca-d6d5-4d78-a8a7-0b8a3678fe43" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the capture", "id": "f13d7009-1262-47db-aad0-2a742902b9ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "attachments" ], "variable": [ { "id": "f4589fe3-1a2f-48e3-b6e0-9d54d5f85941", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the capture" }, "response": [ { "id": "1b3322fa-d331-46a7-bed6-1c28d9d7f1fd", "name": "The attachments associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "attachments" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1b3322fa-d331-46a7-bed6-1c28d9d7f1fd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f13d7009-1262-47db-aad0-2a742902b9ff" } ], "id": "77ef6924-08a3-441b-88d2-fee7244ab737", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-77ef6924-08a3-441b-88d2-fee7244ab737" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the capture", "id": "9af810da-c363-4868-88c4-8fb5e38b5c92", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/events", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "events" ], "variable": [ { "id": "1177c98b-af20-4318-87be-f37ff0d95c4b", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the capture" }, "response": [ { "id": "fa6fc015-60f6-42c5-82ea-105c16bfe02a", "name": "The events associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/events", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "events" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa6fc015-60f6-42c5-82ea-105c16bfe02a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9af810da-c363-4868-88c4-8fb5e38b5c92" } ], "id": "8c333c6d-e310-484f-8e8e-2108c5a078a9", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8c333c6d-e310-484f-8e8e-2108c5a078a9" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the capture", "id": "836823e3-218c-48ff-a840-4bcf3954f670", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "event_stores" ], "variable": [ { "id": "1143e708-8d3e-4228-a070-e162e9112939", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the capture" }, "response": [ { "id": "37a27ee8-be3e-4999-9cf7-26f8584811fb", "name": "The event_stores associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "event_stores" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-37a27ee8-be3e-4999-9cf7-26f8584811fb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-836823e3-218c-48ff-a840-4bcf3954f670" } ], "id": "f9f84251-afca-4d53-b03e-bd6ff5a61d4d", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f9f84251-afca-4d53-b03e-bd6ff5a61d4d" }, { "name": "reference_authorization", "item": [ { "name": "Retrieve the reference authorization associated to the capture", "id": "58ab6c59-c1ed-4d95-b83c-82d4fade3219", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/reference_authorization", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "reference_authorization" ], "variable": [ { "id": "86e2b63e-9226-4371-938e-ba087ec50e10", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reference authorization associated to the capture" }, "response": [ { "id": "843334e9-b1d9-449a-9004-2d08594a29ae", "name": "The reference_authorization associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/reference_authorization", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "reference_authorization" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-843334e9-b1d9-449a-9004-2d08594a29ae" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-58ab6c59-c1ed-4d95-b83c-82d4fade3219" } ], "id": "49493f8e-3eff-4d20-8143-d3babc7da0bb", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-49493f8e-3eff-4d20-8143-d3babc7da0bb" }, { "name": "refunds", "item": [ { "name": "Retrieve the refunds associated to the capture", "id": "30028357-3e2c-4894-9e8b-79ff6489fe26", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/refunds", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "refunds" ], "variable": [ { "id": "aa347e1b-a872-4609-90c8-21522969caef", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the refunds associated to the capture" }, "response": [ { "id": "fd285f22-64e1-4fb1-9a20-16e53ee40efd", "name": "The refunds associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/refunds", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "refunds" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fd285f22-64e1-4fb1-9a20-16e53ee40efd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-30028357-3e2c-4894-9e8b-79ff6489fe26" } ], "id": "3e24da53-84a9-4494-b3a4-9e2599e1d07e", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3e24da53-84a9-4494-b3a4-9e2599e1d07e" }, { "name": "return", "item": [ { "name": "Retrieve the return associated to the capture", "id": "834a9544-6ba9-4d4f-9146-22762bda3977", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/captures/:captureId/return", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "return" ], "variable": [ { "id": "78ad49e0-9310-4289-a538-972c95ad8201", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the return associated to the capture" }, "response": [ { "id": "b2870d21-c1f1-4142-b58c-da330a5d4e4b", "name": "The return associated to the capture", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId/return", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId", "return" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b2870d21-c1f1-4142-b58c-da330a5d4e4b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-834a9544-6ba9-4d4f-9146-22762bda3977" } ], "id": "c58cc7a7-da10-4dd9-ac0e-768285e2b318", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c58cc7a7-da10-4dd9-ac0e-768285e2b318" }, { "name": "Retrieve a capture", "id": "aa49986c-dcc0-4f71-aeff-111440a463cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/captures/:captureId", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId" ], "variable": [ { "id": "c6b91d03-45fe-4191-98a9-f7718d633bd9", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a capture" }, "response": [ { "id": "641d6dfc-1e61-40af-b6fe-a86a3550594f", "name": "The capture object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures/:captureId", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"captures\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"authorizations\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"refund_amount_cents\": \"\",\n \"refund_amount_float\": \"\",\n \"formatted_refund_amount\": \"\",\n \"refund_balance_cents\": \"\",\n \"refund_balance_float\": \"\",\n \"formatted_refund_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-641d6dfc-1e61-40af-b6fe-a86a3550594f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-aa49986c-dcc0-4f71-aeff-111440a463cd" }, { "name": "Update a capture", "id": "7594ed40-35e5-47dd-b9a3-b58eb5130908", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_refund\": \"\",\n \"_refund_amount_cents\": \"\",\n \"_cancel\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/captures/:captureId", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId" ], "variable": [ { "id": "d678fa01-5092-49ca-a779-230a18ed1dfe", "key": "captureId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a capture" }, "response": [ { "id": "aed7ef88-f724-4052-baea-69a42315cdb0", "name": "The updated capture object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_refund\": \"\",\n \"_refund_amount_cents\": \"\",\n \"_cancel\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/captures/:captureId", "host": [ "{{baseUrl}}" ], "path": [ "captures", ":captureId" ], "variable": [ { "key": "captureId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"captures\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"authorizations\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"refund_amount_cents\": \"\",\n \"refund_amount_float\": \"\",\n \"formatted_refund_amount\": \"\",\n \"refund_balance_cents\": \"\",\n \"refund_balance_float\": \"\",\n \"formatted_refund_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aed7ef88-f724-4052-baea-69a42315cdb0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7594ed40-35e5-47dd-b9a3-b58eb5130908" } ], "id": "8e0b1d28-d946-4e3f-9812-26b408ca5d52", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8e0b1d28-d946-4e3f-9812-26b408ca5d52" }, { "name": "List all captures", "id": "603515ac-1c60-4def-a25e-a4baa361d9d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/captures", "host": [ "{{baseUrl}}" ], "path": [ "captures" ] }, "description": "List all captures" }, "response": [ { "id": "95e476a9-38bb-4508-9998-700cc5b2ce6a", "name": "A list of capture objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/captures", "host": [ "{{baseUrl}}" ], "path": [ "captures" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"captures\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"captures\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"refund_amount_cents\": \"\",\n \"refund_amount_float\": \"\",\n \"formatted_refund_amount\": \"\",\n \"refund_balance_cents\": \"\",\n \"refund_balance_float\": \"\",\n \"formatted_refund_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"captures\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"voids\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"refund_amount_cents\": \"\",\n \"refund_amount_float\": \"\",\n \"formatted_refund_amount\": \"\",\n \"refund_balance_cents\": \"\",\n \"refund_balance_float\": \"\",\n \"formatted_refund_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-95e476a9-38bb-4508-9998-700cc5b2ce6a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-603515ac-1c60-4def-a25e-a4baa361d9d2" } ], "id": "81051643-af6d-451f-8350-5b4a46b737f4", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-81051643-af6d-451f-8350-5b4a46b737f4" }, { "name": "carrier_accounts", "item": [ { "name": "{carrierAccountId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the carrier account", "id": "ff871bc0-6ace-4626-ae5c-b7b484986944", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId/market", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId", "market" ], "variable": [ { "id": "eefd3ba4-a168-442e-a2c1-0f78d38e5339", "key": "carrierAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the carrier account" }, "response": [ { "id": "608c68dc-ae4f-462b-b751-6cdbf2fe956d", "name": "The market associated to the carrier account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId/market", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId", "market" ], "variable": [ { "key": "carrierAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-608c68dc-ae4f-462b-b751-6cdbf2fe956d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ff871bc0-6ace-4626-ae5c-b7b484986944" } ], "id": "89507462-9d26-4ffb-8fbd-dbaaab4900fb", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-89507462-9d26-4ffb-8fbd-dbaaab4900fb" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the carrier account", "id": "615b1316-dca1-46f6-b80f-72e9b05f6db8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId", "attachments" ], "variable": [ { "id": "fb9b5c41-eb45-4022-9008-5a15597f056d", "key": "carrierAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the carrier account" }, "response": [ { "id": "29b7d7ce-d740-43b8-9cc5-e9aee2c89d38", "name": "The attachments associated to the carrier account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId", "attachments" ], "variable": [ { "key": "carrierAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-29b7d7ce-d740-43b8-9cc5-e9aee2c89d38" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-615b1316-dca1-46f6-b80f-72e9b05f6db8" } ], "id": "07b157da-f7a0-40bd-ba8c-c22b7dd6d9b1", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-07b157da-f7a0-40bd-ba8c-c22b7dd6d9b1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the carrier account", "id": "cf19d992-eec4-4574-a73a-ef2dc453405f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId", "event_stores" ], "variable": [ { "id": "7b37dc42-c2cf-4d48-bec0-0effbdcae754", "key": "carrierAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the carrier account" }, "response": [ { "id": "c148e44f-1c84-463d-ba79-762cc1339cff", "name": "The event_stores associated to the carrier account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId", "event_stores" ], "variable": [ { "key": "carrierAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c148e44f-1c84-463d-ba79-762cc1339cff" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cf19d992-eec4-4574-a73a-ef2dc453405f" } ], "id": "3359e74e-b7f9-49ef-be23-006d4eb472f6", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3359e74e-b7f9-49ef-be23-006d4eb472f6" }, { "name": "Retrieve a carrier account", "id": "cff2fa1c-9c71-4001-a609-94c3413d2208", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId" ], "variable": [ { "id": "758092ca-8856-410c-9eee-491797620ca7", "key": "carrierAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a carrier account" }, "response": [ { "id": "e4e4d32d-fbf5-42cb-a6fe-2bc3018f3610", "name": "The carrier account object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId" ], "variable": [ { "key": "carrierAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carrier_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"easypost_id\": \"\",\n \"credentials\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e4e4d32d-fbf5-42cb-a6fe-2bc3018f3610" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cff2fa1c-9c71-4001-a609-94c3413d2208" }, { "name": "Update a carrier account", "id": "d9738502-0a23-4511-80ae-ffaefa3648bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"credentials\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId" ], "variable": [ { "id": "7ba33c2b-047d-46f2-a4be-54b432daa345", "key": "carrierAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a carrier account" }, "response": [ { "id": "528bd30f-3d58-4c75-9057-660a42d21f6e", "name": "The updated carrier account object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"credentials\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId" ], "variable": [ { "key": "carrierAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carrier_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"easypost_id\": \"\",\n \"credentials\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-528bd30f-3d58-4c75-9057-660a42d21f6e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9738502-0a23-4511-80ae-ffaefa3648bb" }, { "name": "Delete a carrier account", "id": "81d0147c-c415-484b-9de7-6700c5b0f640", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId" ], "variable": [ { "id": "b8d4e98e-e1c6-41ab-9eaf-6a70e7c9e9b4", "key": "carrierAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a carrier account" }, "response": [ { "id": "b0a70f5c-8382-4566-a508-40bc4cde1253", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/carrier_accounts/:carrierAccountId", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts", ":carrierAccountId" ], "variable": [ { "key": "carrierAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b0a70f5c-8382-4566-a508-40bc4cde1253" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-81d0147c-c415-484b-9de7-6700c5b0f640" } ], "id": "9cf666e8-301b-4e34-a7e2-c606174b2066", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-9cf666e8-301b-4e34-a7e2-c606174b2066" }, { "name": "List all carrier accounts", "id": "454ca441-e1c1-468f-b0f8-e46dd859ea9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/carrier_accounts", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts" ] }, "description": "List all carrier accounts" }, "response": [ { "id": "e66db3b8-72b6-4559-8f23-1af26633347c", "name": "A list of carrier account objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/carrier_accounts", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"carrier_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"easypost_id\": \"\",\n \"credentials\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"carrier_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"easypost_id\": \"\",\n \"credentials\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e66db3b8-72b6-4559-8f23-1af26633347c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-454ca441-e1c1-468f-b0f8-e46dd859ea9b" }, { "name": "Create a carrier account", "id": "39553a2d-f666-4e15-8626-4fc6bffd2bcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"credentials\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/carrier_accounts", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts" ] }, "description": "Create a carrier account" }, "response": [ { "id": "878496f6-33e7-49bf-aca7-3a20785978b1", "name": "The created carrier account object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"credentials\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/carrier_accounts", "host": [ "{{baseUrl}}" ], "path": [ "carrier_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"carrier_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"easypost_type\": \"\",\n \"easypost_id\": \"\",\n \"credentials\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-878496f6-33e7-49bf-aca7-3a20785978b1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-39553a2d-f666-4e15-8626-4fc6bffd2bcf" } ], "id": "b457f281-8fdd-42d5-a63c-a45593b242a7", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-b457f281-8fdd-42d5-a63c-a45593b242a7" }, { "name": "checkout_com_gateways", "item": [ { "name": "{checkoutComGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the checkout.com gateway", "id": "7ce92902-1fc1-443a-99aa-5ca5a6db6ea9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId", "payment_methods" ], "variable": [ { "id": "36f55caf-6b06-455a-853c-103afcc99704", "key": "checkoutComGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the checkout.com gateway" }, "response": [ { "id": "68d9e1a7-b4ba-4843-895f-459f8ea526c9", "name": "The payment_methods associated to the checkout.com gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId", "payment_methods" ], "variable": [ { "key": "checkoutComGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-68d9e1a7-b4ba-4843-895f-459f8ea526c9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7ce92902-1fc1-443a-99aa-5ca5a6db6ea9" } ], "id": "dea8c8da-87cb-4aeb-ad61-d0273fafcee3", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-dea8c8da-87cb-4aeb-ad61-d0273fafcee3" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the checkout.com gateway", "id": "1a667b40-972e-4b51-a299-32ca7de6c339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId", "event_stores" ], "variable": [ { "id": "031aa83a-ee3e-4655-9b2e-ce9bb92cfe0e", "key": "checkoutComGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the checkout.com gateway" }, "response": [ { "id": "db142632-fd18-47bb-bd07-c6c242e3d91e", "name": "The event_stores associated to the checkout.com gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId", "event_stores" ], "variable": [ { "key": "checkoutComGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-db142632-fd18-47bb-bd07-c6c242e3d91e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1a667b40-972e-4b51-a299-32ca7de6c339" } ], "id": "657e4c9e-142e-466f-afc7-00d8e568eb74", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-657e4c9e-142e-466f-afc7-00d8e568eb74" }, { "name": "checkout_com_payments", "item": [ { "name": "Retrieve the checkout com payments associated to the checkout.com gateway", "id": "ee2ce566-d081-465f-9ad6-d27392aba91f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId/checkout_com_payments", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId", "checkout_com_payments" ], "variable": [ { "id": "03f39e69-c43f-4786-a6b5-230b5ee4063d", "key": "checkoutComGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the checkout com payments associated to the checkout.com gateway" }, "response": [ { "id": "7aa75d71-42f9-479e-8ffe-86b5a52561fc", "name": "The checkout_com_payments associated to the checkout.com gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId/checkout_com_payments", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId", "checkout_com_payments" ], "variable": [ { "key": "checkoutComGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7aa75d71-42f9-479e-8ffe-86b5a52561fc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ee2ce566-d081-465f-9ad6-d27392aba91f" } ], "id": "1d745603-e521-44c4-8788-de801ef7f2c0", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-1d745603-e521-44c4-8788-de801ef7f2c0" }, { "name": "Retrieve a checkout.com gateway", "id": "54b4aef6-39a8-46c8-9277-f556556fe595", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId" ], "variable": [ { "id": "9d8fdd42-a665-4073-a980-ddd2beef9766", "key": "checkoutComGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a checkout.com gateway" }, "response": [ { "id": "dc9f8103-9897-41a7-a261-95cb115cefc6", "name": "The checkout.com gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId" ], "variable": [ { "key": "checkoutComGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"checkout_com_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"checkout_com_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dc9f8103-9897-41a7-a261-95cb115cefc6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-54b4aef6-39a8-46c8-9277-f556556fe595" }, { "name": "Update a checkout.com gateway", "id": "1649c677-1a9b-486d-b599-0ac5d98dcc9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"secret_key\": \"\",\n \"public_key\": \"\"\n },\n \"relationships\": {\n \"checkout_com_payments\": {\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId" ], "variable": [ { "id": "f10d28a8-3a6e-47b4-81b9-e43c9960836b", "key": "checkoutComGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a checkout.com gateway" }, "response": [ { "id": "a1b67f90-d1b8-445e-9454-9eab31298514", "name": "The updated checkout.com gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"secret_key\": \"\",\n \"public_key\": \"\"\n },\n \"relationships\": {\n \"checkout_com_payments\": {\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId" ], "variable": [ { "key": "checkoutComGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"checkout_com_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"checkout_com_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a1b67f90-d1b8-445e-9454-9eab31298514" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1649c677-1a9b-486d-b599-0ac5d98dcc9d" }, { "name": "Delete a checkout.com gateway", "id": "c9180fec-4707-4c6f-bc54-b0f8400ba9f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId" ], "variable": [ { "id": "5f45ed51-300f-4bc8-8a7e-e6b3ea714c86", "key": "checkoutComGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a checkout.com gateway" }, "response": [ { "id": "40dbb23d-e7de-4366-a5a7-fe018295971e", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways/:checkoutComGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways", ":checkoutComGatewayId" ], "variable": [ { "key": "checkoutComGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-40dbb23d-e7de-4366-a5a7-fe018295971e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c9180fec-4707-4c6f-bc54-b0f8400ba9f7" } ], "id": "0be82ebb-224d-427a-8604-61580d4dbd36", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-0be82ebb-224d-427a-8604-61580d4dbd36" }, { "name": "List all checkout.com gateways", "id": "07864b78-0268-4475-83f9-06b31f8ad8ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways" ] }, "description": "List all checkout.com gateways" }, "response": [ { "id": "2c38ac1d-7e1f-4bd1-afea-28bae4f746c8", "name": "A list of checkout.com gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_gateways", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"checkout_com_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"checkout_com_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"checkout_com_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"checkout_com_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2c38ac1d-7e1f-4bd1-afea-28bae4f746c8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07864b78-0268-4475-83f9-06b31f8ad8ce" }, { "name": "Create a checkout.com gateway", "id": "7fd2f6f3-3b76-4122-8395-da8ba2c08089", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"secret_key\": \"\",\n \"public_key\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\"\n },\n \"relationships\": {\n \"checkout_com_payments\": {\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_gateways", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways" ] }, "description": "Create a checkout.com gateway" }, "response": [ { "id": "ead341d8-0d02-4c55-a58f-9f2982de3b74", "name": "The created checkout.com gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"secret_key\": \"\",\n \"public_key\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\"\n },\n \"relationships\": {\n \"checkout_com_payments\": {\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_gateways", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"checkout_com_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"checkout_com_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ead341d8-0d02-4c55-a58f-9f2982de3b74" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7fd2f6f3-3b76-4122-8395-da8ba2c08089" } ], "id": "44e1d4a8-550d-48a8-bb87-65df1ef80626", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-44e1d4a8-550d-48a8-bb87-65df1ef80626" }, { "name": "checkout_com_payments", "item": [ { "name": "{checkoutComPaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the checkout.com payment", "id": "4037fe65-cfdb-4e22-9631-21ff587db9a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId", "order" ], "variable": [ { "id": "323f45ad-f126-4c13-90dd-ccf220c5b652", "key": "checkoutComPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the checkout.com payment" }, "response": [ { "id": "55a18578-7b6c-4e9a-8e53-ba780bedfaea", "name": "The order associated to the checkout.com payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId", "order" ], "variable": [ { "key": "checkoutComPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-55a18578-7b6c-4e9a-8e53-ba780bedfaea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4037fe65-cfdb-4e22-9631-21ff587db9a7" } ], "id": "15717958-e204-457d-8824-e9b9bbb05be5", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-15717958-e204-457d-8824-e9b9bbb05be5" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the checkout.com payment", "id": "bff88f17-973f-4308-a165-7b0b88d47a4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId", "payment_gateway" ], "variable": [ { "id": "dae652c6-fb49-4593-b5b8-84b287c15a21", "key": "checkoutComPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the checkout.com payment" }, "response": [ { "id": "2816df34-02a1-4eb6-ad51-3fc9974eb5d9", "name": "The payment_gateway associated to the checkout.com payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId", "payment_gateway" ], "variable": [ { "key": "checkoutComPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2816df34-02a1-4eb6-ad51-3fc9974eb5d9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bff88f17-973f-4308-a165-7b0b88d47a4c" } ], "id": "7cb966c5-18cc-47bf-9783-351d75df7f3a", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7cb966c5-18cc-47bf-9783-351d75df7f3a" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the checkout.com payment", "id": "d3c6a644-7361-451a-bc21-4613e77de7fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId", "event_stores" ], "variable": [ { "id": "1ec54428-6f3b-458a-abcd-e752b3b0200f", "key": "checkoutComPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the checkout.com payment" }, "response": [ { "id": "20c5a3b1-d504-432c-84c3-4a0a2fd3dede", "name": "The event_stores associated to the checkout.com payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId", "event_stores" ], "variable": [ { "key": "checkoutComPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-20c5a3b1-d504-432c-84c3-4a0a2fd3dede" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d3c6a644-7361-451a-bc21-4613e77de7fd" } ], "id": "7ef425fd-0d2e-4ff5-b21f-3e5375787f5b", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7ef425fd-0d2e-4ff5-b21f-3e5375787f5b" }, { "name": "Retrieve a checkout.com payment", "id": "9a844032-060e-47df-a2b8-898e65a150d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId" ], "variable": [ { "id": "e9dd97f5-1269-4bd9-8de6-fff8f0570ccf", "key": "checkoutComPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a checkout.com payment" }, "response": [ { "id": "1c4da073-5b46-467a-81a1-ef1fac21fde5", "name": "The checkout.com payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId" ], "variable": [ { "key": "checkoutComPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"checkout_com_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"token\": \"\",\n \"payment_session\": {},\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"source_id\": \"\",\n \"customer_token\": \"\",\n \"redirect_uri\": \"\",\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1c4da073-5b46-467a-81a1-ef1fac21fde5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9a844032-060e-47df-a2b8-898e65a150d8" }, { "name": "Update a checkout.com payment", "id": "9952e276-9213-4115-9416-3b9e2262e7f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"token\": \"\",\n \"_details\": \"\",\n \"_refresh\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId" ], "variable": [ { "id": "12ab6fae-ecee-4b2b-837b-80aeee4f247c", "key": "checkoutComPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a checkout.com payment" }, "response": [ { "id": "20dffc74-8b32-4da3-9bf5-2412a03dd904", "name": "The updated checkout.com payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"token\": \"\",\n \"_details\": \"\",\n \"_refresh\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId" ], "variable": [ { "key": "checkoutComPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"checkout_com_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"token\": \"\",\n \"payment_session\": {},\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"source_id\": \"\",\n \"customer_token\": \"\",\n \"redirect_uri\": \"\",\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-20dffc74-8b32-4da3-9bf5-2412a03dd904" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9952e276-9213-4115-9416-3b9e2262e7f8" }, { "name": "Delete a checkout.com payment", "id": "be78b1d0-2345-492d-9eb2-5c3621c72f71", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId" ], "variable": [ { "id": "d633b5c3-960f-4515-ae4c-7950e6b16dbe", "key": "checkoutComPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a checkout.com payment" }, "response": [ { "id": "f250d097-20e0-404d-8afa-b5074ed2815c", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments/:checkoutComPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments", ":checkoutComPaymentId" ], "variable": [ { "key": "checkoutComPaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f250d097-20e0-404d-8afa-b5074ed2815c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-be78b1d0-2345-492d-9eb2-5c3621c72f71" } ], "id": "67e8139f-bbaa-4648-9d98-9948402f3ed9", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-67e8139f-bbaa-4648-9d98-9948402f3ed9" }, { "name": "List all checkout.com payments", "id": "d22607e7-9ad6-4a7b-a7ea-9a5b37577f5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments" ] }, "description": "List all checkout.com payments" }, "response": [ { "id": "bbc00930-d418-4b81-9577-ec01d6856012", "name": "A list of checkout.com payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/checkout_com_payments", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"checkout_com_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"token\": \"\",\n \"payment_session\": {},\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"source_id\": \"\",\n \"customer_token\": \"\",\n \"redirect_uri\": \"\",\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"checkout_com_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"token\": \"\",\n \"payment_session\": {},\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"source_id\": \"\",\n \"customer_token\": \"\",\n \"redirect_uri\": \"\",\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bbc00930-d418-4b81-9577-ec01d6856012" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d22607e7-9ad6-4a7b-a7ea-9a5b37577f5a" }, { "name": "Create a checkout.com payment", "id": "1d2d81ca-1999-4f73-bf48-9243c7569043", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"attributes\": {\n \"token\": \"\",\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_payments", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments" ] }, "description": "Create a checkout.com payment" }, "response": [ { "id": "11074d3b-90f1-4449-876f-b3c74bf5fc6b", "name": "The created checkout.com payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"checkout_com_payments\",\n \"attributes\": {\n \"token\": \"\",\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checkout_com_payments", "host": [ "{{baseUrl}}" ], "path": [ "checkout_com_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"checkout_com_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"public_key\": \"\",\n \"token\": \"\",\n \"payment_session\": {},\n \"success_url\": \"\",\n \"failure_url\": \"\",\n \"source_id\": \"\",\n \"customer_token\": \"\",\n \"redirect_uri\": \"\",\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-11074d3b-90f1-4449-876f-b3c74bf5fc6b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1d2d81ca-1999-4f73-bf48-9243c7569043" } ], "id": "90444055-6b43-4c79-b154-e42290dddca1", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-90444055-6b43-4c79-b154-e42290dddca1" }, { "name": "cleanups", "item": [ { "name": "{cleanupId}", "item": [ { "name": "events", "item": [ { "name": "Retrieve the events associated to the cleanup", "id": "e9ebaf7e-d8b2-4df1-96ed-2778689cdc0f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId/events", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId", "events" ], "variable": [ { "id": "2a83df43-8b23-43cd-848e-ceeb5261c55a", "key": "cleanupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the cleanup" }, "response": [ { "id": "1d6415b2-2bdb-46aa-bcc4-5b63a479d67a", "name": "The events associated to the cleanup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId/events", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId", "events" ], "variable": [ { "key": "cleanupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1d6415b2-2bdb-46aa-bcc4-5b63a479d67a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e9ebaf7e-d8b2-4df1-96ed-2778689cdc0f" } ], "id": "dd55b358-41a8-457a-a5e4-64652511ce72", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-dd55b358-41a8-457a-a5e4-64652511ce72" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the cleanup", "id": "bddac2a0-2edb-4c1d-b95a-8ceb88225779", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId", "event_stores" ], "variable": [ { "id": "1a931e2d-e79b-41e0-af5a-c789170319e6", "key": "cleanupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the cleanup" }, "response": [ { "id": "8266dded-877e-4eac-ad0b-674e6728cc5f", "name": "The event_stores associated to the cleanup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId", "event_stores" ], "variable": [ { "key": "cleanupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8266dded-877e-4eac-ad0b-674e6728cc5f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bddac2a0-2edb-4c1d-b95a-8ceb88225779" } ], "id": "db3ce48b-c8d7-4405-a07f-999e2236a9bf", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-db3ce48b-c8d7-4405-a07f-999e2236a9bf" }, { "name": "Retrieve a cleanup", "id": "6d43e318-1839-4bac-bc32-3ea22fbd7f7d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId" ], "variable": [ { "id": "95d6df0b-dc90-4e3c-8281-165589e5853e", "key": "cleanupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a cleanup" }, "response": [ { "id": "ae81dfad-3278-4511-8e84-5768305dec63", "name": "The cleanup object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId" ], "variable": [ { "key": "cleanupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"cleanups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"filters\": {},\n \"records_count\": \"\",\n \"errors_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ae81dfad-3278-4511-8e84-5768305dec63" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6d43e318-1839-4bac-bc32-3ea22fbd7f7d" }, { "name": "Update a cleanup", "id": "3da78f14-e0f1-479d-8cdd-00323e370434", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cleanups\",\n \"id\": \"\",\n \"attributes\": {\n \"_interrupt\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId" ], "variable": [ { "id": "93865426-9805-4d24-9052-f31535d56f8f", "key": "cleanupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a cleanup" }, "response": [ { "id": "2e174893-b55d-4ff9-a2df-b9a5a9891613", "name": "The updated cleanup object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cleanups\",\n \"id\": \"\",\n \"attributes\": {\n \"_interrupt\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId" ], "variable": [ { "key": "cleanupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"cleanups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"filters\": {},\n \"records_count\": \"\",\n \"errors_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2e174893-b55d-4ff9-a2df-b9a5a9891613" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3da78f14-e0f1-479d-8cdd-00323e370434" }, { "name": "Delete a cleanup", "id": "5896ba8c-c4dd-45a2-bf16-de3b6e389704", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId" ], "variable": [ { "id": "73246721-59e8-45a2-a5a7-2c932b695ede", "key": "cleanupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a cleanup" }, "response": [ { "id": "efc54a4f-f023-41b1-bdfe-36ae24d83b11", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cleanups/:cleanupId", "host": [ "{{baseUrl}}" ], "path": [ "cleanups", ":cleanupId" ], "variable": [ { "key": "cleanupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-efc54a4f-f023-41b1-bdfe-36ae24d83b11" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5896ba8c-c4dd-45a2-bf16-de3b6e389704" } ], "id": "1db69dd1-0636-4c1d-93a1-b593af37c30b", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-1db69dd1-0636-4c1d-93a1-b593af37c30b" }, { "name": "List all cleanups", "id": "6198476b-2960-4238-8d57-03eae523dd61", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/cleanups", "host": [ "{{baseUrl}}" ], "path": [ "cleanups" ] }, "description": "List all cleanups" }, "response": [ { "id": "8eeaf28d-67cf-41b9-bcfe-e26d431e96f5", "name": "A list of cleanup objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/cleanups", "host": [ "{{baseUrl}}" ], "path": [ "cleanups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"cleanups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"status\": \"in_progress\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"filters\": {},\n \"records_count\": \"\",\n \"errors_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"cleanups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"status\": \"interrupted\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"filters\": {},\n \"records_count\": \"\",\n \"errors_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8eeaf28d-67cf-41b9-bcfe-e26d431e96f5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6198476b-2960-4238-8d57-03eae523dd61" }, { "name": "Create a cleanup", "id": "dbc7af24-1211-4970-8a5b-231311615920", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cleanups\",\n \"attributes\": {\n \"resource_type\": \"\",\n \"filters\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cleanups", "host": [ "{{baseUrl}}" ], "path": [ "cleanups" ] }, "description": "Create a cleanup" }, "response": [ { "id": "765bfeae-f0e9-4d5f-af2c-2505db91c9de", "name": "The created cleanup object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"cleanups\",\n \"attributes\": {\n \"resource_type\": \"\",\n \"filters\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cleanups", "host": [ "{{baseUrl}}" ], "path": [ "cleanups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"cleanups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"filters\": {},\n \"records_count\": \"\",\n \"errors_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-765bfeae-f0e9-4d5f-af2c-2505db91c9de" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dbc7af24-1211-4970-8a5b-231311615920" } ], "id": "ba8ebb44-ee7e-493b-ad06-f4c8cde6433c", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-ba8ebb44-ee7e-493b-ad06-f4c8cde6433c" }, { "name": "coupon_codes_promotion_rules", "item": [ { "name": "{couponCodesPromotionRuleId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the coupon codes promotion rule", "id": "cae843cc-1b51-4459-bf82-c499c4f780a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId", "event_stores" ], "variable": [ { "id": "6d8018a3-1ced-4ff7-8043-951e7cc17e53", "key": "couponCodesPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the coupon codes promotion rule" }, "response": [ { "id": "40d87b0d-3260-43c3-aeb3-2fec233ebaa3", "name": "The event_stores associated to the coupon codes promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId", "event_stores" ], "variable": [ { "key": "couponCodesPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-40d87b0d-3260-43c3-aeb3-2fec233ebaa3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cae843cc-1b51-4459-bf82-c499c4f780a4" } ], "id": "74e1997a-ebf9-49ce-9e99-4702388b4088", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-74e1997a-ebf9-49ce-9e99-4702388b4088" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the coupon codes promotion rule", "id": "2ae45ad9-8406-46a6-85c5-1b85ea5d52a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId", "coupons" ], "variable": [ { "id": "23757852-9305-4f7e-8aa5-c4ee235816d8", "key": "couponCodesPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the coupon codes promotion rule" }, "response": [ { "id": "c64c220c-ebaa-4a8f-93ba-de9b48d7e116", "name": "The coupons associated to the coupon codes promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId", "coupons" ], "variable": [ { "key": "couponCodesPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c64c220c-ebaa-4a8f-93ba-de9b48d7e116" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2ae45ad9-8406-46a6-85c5-1b85ea5d52a2" } ], "id": "fdfdcfd1-6808-43ef-bf07-3ffb833737d2", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-fdfdcfd1-6808-43ef-bf07-3ffb833737d2" }, { "name": "Retrieve a coupon codes promotion rule", "id": "37b91932-01ab-4b0e-9585-69482a89d044", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId" ], "variable": [ { "id": "f3857522-aacc-407f-ad62-cb7ac9879de2", "key": "couponCodesPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a coupon codes promotion rule" }, "response": [ { "id": "1b6f38e0-0ff5-41d5-a10d-1588c66f27f0", "name": "The coupon codes promotion rule object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId" ], "variable": [ { "key": "couponCodesPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupon_codes_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1b6f38e0-0ff5-41d5-a10d-1588c66f27f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-37b91932-01ab-4b0e-9585-69482a89d044" }, { "name": "Update a coupon codes promotion rule", "id": "d5c83279-b094-42e2-8bc8-b8840dd75058", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId" ], "variable": [ { "id": "a18adee1-85ec-4982-a74f-8638a6b9241a", "key": "couponCodesPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a coupon codes promotion rule" }, "response": [ { "id": "e0744881-7c8b-4c59-8885-520aaa579588", "name": "The updated coupon codes promotion rule object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId" ], "variable": [ { "key": "couponCodesPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupon_codes_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e0744881-7c8b-4c59-8885-520aaa579588" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d5c83279-b094-42e2-8bc8-b8840dd75058" }, { "name": "Delete a coupon codes promotion rule", "id": "24a5a090-8c01-45cc-a946-0c04aa537b15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId" ], "variable": [ { "id": "0afca000-7859-4583-b8dc-a149b911aade", "key": "couponCodesPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a coupon codes promotion rule" }, "response": [ { "id": "56728473-2e34-4332-8d0f-e914ecf18aa4", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules/:couponCodesPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules", ":couponCodesPromotionRuleId" ], "variable": [ { "key": "couponCodesPromotionRuleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-56728473-2e34-4332-8d0f-e914ecf18aa4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-24a5a090-8c01-45cc-a946-0c04aa537b15" } ], "id": "abf933a3-5034-45ff-955b-076108553168", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-abf933a3-5034-45ff-955b-076108553168" }, { "name": "List all coupon codes promotion rules", "id": "6e01fcb5-e1ae-4fef-b691-c6664bb53c28", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules" ] }, "description": "List all coupon codes promotion rules" }, "response": [ { "id": "9a9f5f08-cef4-475f-80c7-18af6e044ff2", "name": "A list of coupon codes promotion rule objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"coupon_codes_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"sku_list_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"coupon_codes_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9a9f5f08-cef4-475f-80c7-18af6e044ff2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6e01fcb5-e1ae-4fef-b691-c6664bb53c28" }, { "name": "Create a coupon codes promotion rule", "id": "70c39dfa-4a1f-4b16-8476-b7bfa3fd2cf5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules" ] }, "description": "Create a coupon codes promotion rule" }, "response": [ { "id": "ac1da3dd-27e9-4c57-9d79-a1ad3ecde4b0", "name": "The created coupon codes promotion rule object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_codes_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "coupon_codes_promotion_rules" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupon_codes_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ac1da3dd-27e9-4c57-9d79-a1ad3ecde4b0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-70c39dfa-4a1f-4b16-8476-b7bfa3fd2cf5" } ], "id": "c93a3494-901a-4df8-9516-2ae9ec4870cf", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c93a3494-901a-4df8-9516-2ae9ec4870cf" }, { "name": "coupon_recipients", "item": [ { "name": "{couponRecipientId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the coupon recipient", "id": "24043e16-3ad2-4e73-8974-af67048a95ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId/customer", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId", "customer" ], "variable": [ { "id": "44a70024-acc9-4c1c-a393-b8a196c3fd80", "key": "couponRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the coupon recipient" }, "response": [ { "id": "21c3e4d6-524f-4aa1-a2f0-11833d789dce", "name": "The customer associated to the coupon recipient", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId/customer", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId", "customer" ], "variable": [ { "key": "couponRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-21c3e4d6-524f-4aa1-a2f0-11833d789dce" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-24043e16-3ad2-4e73-8974-af67048a95ec" } ], "id": "05440842-416e-4398-96b0-492a88af7611", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-05440842-416e-4398-96b0-492a88af7611" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the coupon recipient", "id": "98586b98-6ec7-4df7-84b3-c9fede3c6252", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId", "event_stores" ], "variable": [ { "id": "2fe37f46-6cf0-4924-9a7c-642bd7b9c235", "key": "couponRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the coupon recipient" }, "response": [ { "id": "5c159adc-e6d5-433e-8f9d-7f39c8f969e5", "name": "The event_stores associated to the coupon recipient", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId", "event_stores" ], "variable": [ { "key": "couponRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5c159adc-e6d5-433e-8f9d-7f39c8f969e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98586b98-6ec7-4df7-84b3-c9fede3c6252" } ], "id": "e1c98555-45ec-464b-91e6-6a0fa7cb6341", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-e1c98555-45ec-464b-91e6-6a0fa7cb6341" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the coupon recipient", "id": "05c2e2d5-32df-46fc-a2b3-e87190ff587a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId", "attachments" ], "variable": [ { "id": "5ea70797-68b6-4162-a545-623d001b7118", "key": "couponRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the coupon recipient" }, "response": [ { "id": "a494f7c3-e40e-4a65-8120-b9ef10ad44af", "name": "The attachments associated to the coupon recipient", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId", "attachments" ], "variable": [ { "key": "couponRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a494f7c3-e40e-4a65-8120-b9ef10ad44af" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-05c2e2d5-32df-46fc-a2b3-e87190ff587a" } ], "id": "2b7e07aa-7601-4bfa-bbb5-6accc104450b", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-2b7e07aa-7601-4bfa-bbb5-6accc104450b" }, { "name": "Retrieve a coupon recipient", "id": "2040999a-87a2-4a31-bf91-6c7723d0ea71", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId" ], "variable": [ { "id": "1c3d1e7c-45c2-4be0-bd3f-0b330c069455", "key": "couponRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a coupon recipient" }, "response": [ { "id": "e908fac4-f627-4107-ace7-ed0929222d5f", "name": "The coupon recipient object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId" ], "variable": [ { "key": "couponRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupon_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e908fac4-f627-4107-ace7-ed0929222d5f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2040999a-87a2-4a31-bf91-6c7723d0ea71" }, { "name": "Update a coupon recipient", "id": "e9f4eca9-58a4-4fa3-b648-f98674999a31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"id\": \"\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId" ], "variable": [ { "id": "f8eee1f3-9c3f-4cf4-ae9a-0a1182efa32f", "key": "couponRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a coupon recipient" }, "response": [ { "id": "b10ae1f9-d5a3-4143-8201-64bed0cebf1b", "name": "The updated coupon recipient object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"id\": \"\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId" ], "variable": [ { "key": "couponRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupon_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b10ae1f9-d5a3-4143-8201-64bed0cebf1b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e9f4eca9-58a4-4fa3-b648-f98674999a31" }, { "name": "Delete a coupon recipient", "id": "478ede15-e92c-4f44-97c4-1a2c163c5c05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId" ], "variable": [ { "id": "12760e3e-d9bb-4150-a267-4d07a7471a50", "key": "couponRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a coupon recipient" }, "response": [ { "id": "1516f209-a597-4d15-87a1-81de2cdd030a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_recipients/:couponRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients", ":couponRecipientId" ], "variable": [ { "key": "couponRecipientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1516f209-a597-4d15-87a1-81de2cdd030a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-478ede15-e92c-4f44-97c4-1a2c163c5c05" } ], "id": "f45a4893-b7a4-4f5d-81cc-a451286b3667", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f45a4893-b7a4-4f5d-81cc-a451286b3667" }, { "name": "List all coupon recipients", "id": "04c00345-eae0-4396-bf4b-f8235f5318ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/coupon_recipients", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients" ] }, "description": "List all coupon recipients" }, "response": [ { "id": "b7591af4-3274-41ba-890b-4b9ad4f599b3", "name": "A list of coupon recipient objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupon_recipients", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"coupon_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"coupon_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b7591af4-3274-41ba-890b-4b9ad4f599b3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-04c00345-eae0-4396-bf4b-f8235f5318ff" }, { "name": "Create a coupon recipient", "id": "ca8c23c4-b5f5-48b2-89d1-3937a8813d9f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_recipients", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients" ] }, "description": "Create a coupon recipient" }, "response": [ { "id": "581b3247-1326-4712-9c4f-6b85dbae7dec", "name": "The created coupon recipient object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupon_recipients", "host": [ "{{baseUrl}}" ], "path": [ "coupon_recipients" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupon_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-581b3247-1326-4712-9c4f-6b85dbae7dec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ca8c23c4-b5f5-48b2-89d1-3937a8813d9f" } ], "id": "11713fcc-ca4c-4014-8554-da00573ba719", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-11713fcc-ca4c-4014-8554-da00573ba719" }, { "name": "coupons", "item": [ { "name": "{couponId}", "item": [ { "name": "promotion_rule", "item": [ { "name": "Retrieve the promotion rule associated to the coupon", "id": "ad4914c4-3fd2-4e97-b470-37989ef22550", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:couponId/promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "promotion_rule" ], "variable": [ { "id": "19f959e2-ef94-428d-b6cd-2f222f1405a7", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the promotion rule associated to the coupon" }, "response": [ { "id": "1b978878-f3a8-4d55-9cc8-af94e9d66524", "name": "The promotion_rule associated to the coupon", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId/promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "promotion_rule" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1b978878-f3a8-4d55-9cc8-af94e9d66524" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad4914c4-3fd2-4e97-b470-37989ef22550" } ], "id": "3930b7ec-d678-4372-acc5-d6ad91c78b02", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-3930b7ec-d678-4372-acc5-d6ad91c78b02" }, { "name": "coupon_recipient", "item": [ { "name": "Retrieve the coupon recipient associated to the coupon", "id": "3f186837-f6ac-4545-9bda-8ee4acf9c958", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:couponId/coupon_recipient", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "coupon_recipient" ], "variable": [ { "id": "0f145736-8c64-4bd7-8e95-b822fa599c93", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon recipient associated to the coupon" }, "response": [ { "id": "ebe8df44-a024-45c6-addb-2edce94d854e", "name": "The coupon_recipient associated to the coupon", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId/coupon_recipient", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "coupon_recipient" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ebe8df44-a024-45c6-addb-2edce94d854e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3f186837-f6ac-4545-9bda-8ee4acf9c958" } ], "id": "76176035-0337-4240-8add-3b019710f3db", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-76176035-0337-4240-8add-3b019710f3db" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the coupon", "id": "4350922d-6b8b-4ff3-99c7-771e2241ffdf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:couponId/events", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "events" ], "variable": [ { "id": "a79ed622-2bea-4be7-baf5-eeb35a2a1506", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the coupon" }, "response": [ { "id": "8c16eeb2-a7a0-409a-981d-07eaa1f8b80f", "name": "The events associated to the coupon", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId/events", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "events" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8c16eeb2-a7a0-409a-981d-07eaa1f8b80f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4350922d-6b8b-4ff3-99c7-771e2241ffdf" } ], "id": "d64052c6-4d78-4e9c-9953-c911191d4ed3", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-d64052c6-4d78-4e9c-9953-c911191d4ed3" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the coupon", "id": "d97006eb-4910-47e3-8a79-bc0892cd11a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:couponId/tags", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "tags" ], "variable": [ { "id": "3cc49324-0136-43f4-a641-c5c603931cad", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the coupon" }, "response": [ { "id": "102ef703-c7ff-4c6b-97b6-ab16edde865d", "name": "The tags associated to the coupon", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId/tags", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "tags" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-102ef703-c7ff-4c6b-97b6-ab16edde865d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d97006eb-4910-47e3-8a79-bc0892cd11a0" } ], "id": "57b0f46a-a08a-4668-aeb4-593df1544a43", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-57b0f46a-a08a-4668-aeb4-593df1544a43" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the coupon", "id": "d851a076-387b-421d-ba01-9e0e0aa15d33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:couponId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "event_stores" ], "variable": [ { "id": "775124ba-10c3-4055-bf09-9dc346f36dff", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the coupon" }, "response": [ { "id": "f5abaf02-52a6-4106-ac6e-511650c905f9", "name": "The event_stores associated to the coupon", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId", "event_stores" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f5abaf02-52a6-4106-ac6e-511650c905f9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d851a076-387b-421d-ba01-9e0e0aa15d33" } ], "id": "cab542be-004e-419d-afa7-25d841955cdd", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-cab542be-004e-419d-afa7-25d841955cdd" }, { "name": "Retrieve a coupon", "id": "df7d97f4-d288-4cf9-9b8a-94e707fc6180", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId" ], "variable": [ { "id": "3c703e81-c738-4a6c-8807-06c53e572682", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a coupon" }, "response": [ { "id": "abefd7a0-3d1e-4d06-9bb6-5202f3baecd1", "name": "The coupon object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupons\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"usage_count\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_recipient\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-abefd7a0-3d1e-4d06-9bb6-5202f3baecd1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-df7d97f4-d288-4cf9-9b8a-94e707fc6180" }, { "name": "Update a coupon", "id": "b44e6872-1d2d-491d-9d33-e724c1294297", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons/:couponId", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId" ], "variable": [ { "id": "c9fcbc9f-d748-4f7f-aef8-4bc29adde8ad", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a coupon" }, "response": [ { "id": "942f3542-621f-41ea-8d65-bd2b085869ca", "name": "The updated coupon object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons/:couponId", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId" ], "variable": [ { "key": "couponId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupons\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"usage_count\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_recipient\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-942f3542-621f-41ea-8d65-bd2b085869ca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b44e6872-1d2d-491d-9d33-e724c1294297" }, { "name": "Delete a coupon", "id": "f67fc869-9952-4100-b238-7780fa859b40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/coupons/:couponId", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId" ], "variable": [ { "id": "074f1dd1-5e74-45dd-98df-67f56b007b03", "key": "couponId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a coupon" }, "response": [ { "id": "f7a1a07a-a3d0-4f81-b921-5355e76ce0f1", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons/:couponId", "host": [ "{{baseUrl}}" ], "path": [ "coupons", ":couponId" ], "variable": [ { "key": "couponId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f7a1a07a-a3d0-4f81-b921-5355e76ce0f1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f67fc869-9952-4100-b238-7780fa859b40" } ], "id": "8c49adc0-be87-46f1-84e5-e58b91e25520", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-8c49adc0-be87-46f1-84e5-e58b91e25520" }, { "name": "List all coupons", "id": "4324c031-026d-49a5-a00d-5602ee62c690", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "description": "List all coupons" }, "response": [ { "id": "98729261-2910-43ed-8286-0f26ff8d6da2", "name": "A list of coupon objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"coupons\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"usage_count\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_recipient\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"coupons\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"usage_count\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_recipient\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-98729261-2910-43ed-8286-0f26ff8d6da2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4324c031-026d-49a5-a00d-5602ee62c690" }, { "name": "Create a coupon", "id": "759b9518-03e7-4445-9eab-fd601ec555e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupons\",\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] }, "description": "Create a coupon" }, "response": [ { "id": "1bab36b8-1e60-4554-a390-fb03ad4582c5", "name": "The created coupon object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"coupons\",\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"data\": {\n \"type\": \"coupon_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/coupons", "host": [ "{{baseUrl}}" ], "path": [ "coupons" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"coupons\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"customer_single_use\": \"\",\n \"usage_limit\": \"\",\n \"usage_count\": \"\",\n \"recipient_email\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_recipient\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1bab36b8-1e60-4554-a390-fb03ad4582c5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-759b9518-03e7-4445-9eab-fd601ec555e1" } ], "id": "86383a36-24fb-4083-8af1-19d5be312083", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-86383a36-24fb-4083-8af1-19d5be312083" }, { "name": "custom_promotion_rules", "item": [ { "name": "{customPromotionRuleId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the custom promotion rule", "id": "1b95fe42-a2c2-4b4c-856d-940db6cc4546", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId", "event_stores" ], "variable": [ { "id": "e419cb18-20db-4d09-ab0d-8c6003f5f5db", "key": "customPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the custom promotion rule" }, "response": [ { "id": "78bc7a88-ae6b-4837-8166-1e325f737f04", "name": "The event_stores associated to the custom promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId", "event_stores" ], "variable": [ { "key": "customPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-78bc7a88-ae6b-4837-8166-1e325f737f04" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1b95fe42-a2c2-4b4c-856d-940db6cc4546" } ], "id": "d1a29097-5037-427c-bfc7-84a749e8b881", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-d1a29097-5037-427c-bfc7-84a749e8b881" }, { "name": "Retrieve a custom promotion rule", "id": "7044d7b3-e703-4591-9ec8-31f088e3ed0f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId" ], "variable": [ { "id": "fd641485-e0d2-4e05-bb01-f4cd8825b604", "key": "customPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a custom promotion rule" }, "response": [ { "id": "f64dbc70-ee1d-4e1f-808f-531f0e489b0b", "name": "The custom promotion rule object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId" ], "variable": [ { "key": "customPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"custom_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f64dbc70-ee1d-4e1f-808f-531f0e489b0b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7044d7b3-e703-4591-9ec8-31f088e3ed0f" }, { "name": "Update a custom promotion rule", "id": "d94dd83a-7319-4d9d-95b2-26d834bb4059", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId" ], "variable": [ { "id": "edcc022f-a469-46d9-a7ad-da11d5b18c07", "key": "customPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a custom promotion rule" }, "response": [ { "id": "f9394f52-1d2f-42a8-a157-fdcaf58a8602", "name": "The updated custom promotion rule object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId" ], "variable": [ { "key": "customPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"custom_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f9394f52-1d2f-42a8-a157-fdcaf58a8602" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d94dd83a-7319-4d9d-95b2-26d834bb4059" }, { "name": "Delete a custom promotion rule", "id": "75d53e44-057c-40a2-ad44-abbf1853a584", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId" ], "variable": [ { "id": "f9c18975-a4a3-4024-90e5-6b81e03a0d7c", "key": "customPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a custom promotion rule" }, "response": [ { "id": "0bc55184-7d13-4be9-85a4-f9322920050f", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/custom_promotion_rules/:customPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules", ":customPromotionRuleId" ], "variable": [ { "key": "customPromotionRuleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0bc55184-7d13-4be9-85a4-f9322920050f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-75d53e44-057c-40a2-ad44-abbf1853a584" } ], "id": "eebd6137-fa7e-49a7-bc44-52b47bc1d613", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-eebd6137-fa7e-49a7-bc44-52b47bc1d613" }, { "name": "List all custom promotion rules", "id": "3acd1f9f-8b58-4b54-a981-66f43b50d2ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/custom_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules" ] }, "description": "List all custom promotion rules" }, "response": [ { "id": "95638860-60bb-45fb-bc5a-39dd3310054a", "name": "A list of custom promotion rule objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/custom_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"custom_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"custom_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-95638860-60bb-45fb-bc5a-39dd3310054a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3acd1f9f-8b58-4b54-a981-66f43b50d2ac" }, { "name": "Create a custom promotion rule", "id": "1325e5fe-7d3d-4d95-ac45-2be9aa9f9a49", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/custom_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules" ] }, "description": "Create a custom promotion rule" }, "response": [ { "id": "9a0f339e-a172-4a7e-ae2a-4e4e861b8b97", "name": "The created custom promotion rule object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/custom_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "custom_promotion_rules" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"custom_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"custom_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"filters\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9a0f339e-a172-4a7e-ae2a-4e4e861b8b97" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1325e5fe-7d3d-4d95-ac45-2be9aa9f9a49" } ], "id": "f68560a7-3add-4961-9197-be055aeaaf56", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f68560a7-3add-4961-9197-be055aeaaf56" }, { "name": "customer_addresses", "item": [ { "name": "{customerAddressId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the customer address", "id": "b2008450-3e59-463c-a98e-035a89a76730", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "customer" ], "variable": [ { "id": "5a3737e2-c723-4fe6-8b09-911b5345d059", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the customer address" }, "response": [ { "id": "8f6e9346-c120-407c-8c33-5ff1c42db743", "name": "The customer associated to the customer address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "customer" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8f6e9346-c120-407c-8c33-5ff1c42db743" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b2008450-3e59-463c-a98e-035a89a76730" } ], "id": "dcf9dff0-0548-4968-a197-d44e78ec3c6f", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-dcf9dff0-0548-4968-a197-d44e78ec3c6f" }, { "name": "address", "item": [ { "name": "Retrieve the address associated to the customer address", "id": "9991a910-951e-4754-8695-c33a7632d0fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/address", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "address" ], "variable": [ { "id": "a0b5e815-ee57-4446-a9b2-f638cefd1f27", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the address associated to the customer address" }, "response": [ { "id": "01268c72-7a81-4e3e-a9e2-7b85858d4e96", "name": "The address associated to the customer address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/address", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "address" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-01268c72-7a81-4e3e-a9e2-7b85858d4e96" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9991a910-951e-4754-8695-c33a7632d0fd" } ], "id": "ba32989c-3685-4a71-a0f0-408d952dc21c", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-ba32989c-3685-4a71-a0f0-408d952dc21c" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the customer address", "id": "81779ef3-2808-488e-b1c3-dbf0dc922890", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/events", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "events" ], "variable": [ { "id": "a94247d9-c035-4121-9c7e-94ecf4cac714", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the customer address" }, "response": [ { "id": "af07311e-dcc0-4e58-be81-f2996954b85c", "name": "The events associated to the customer address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/events", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "events" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-af07311e-dcc0-4e58-be81-f2996954b85c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-81779ef3-2808-488e-b1c3-dbf0dc922890" } ], "id": "6d4a1b6f-a0a4-45c5-aa6f-72792af8ae8d", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-6d4a1b6f-a0a4-45c5-aa6f-72792af8ae8d" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the customer address", "id": "cab9b791-6aa7-49b0-ae59-17ffb5ae216a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "event_stores" ], "variable": [ { "id": "393f9fc1-30ed-4edd-8c0e-40d3754afb49", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the customer address" }, "response": [ { "id": "2e1e0411-bb6c-41eb-8910-9611c70565c3", "name": "The event_stores associated to the customer address", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId", "event_stores" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2e1e0411-bb6c-41eb-8910-9611c70565c3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cab9b791-6aa7-49b0-ae59-17ffb5ae216a" } ], "id": "11e3dac3-48eb-4dfb-8aa2-d2505e236bcd", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-11e3dac3-48eb-4dfb-8aa2-d2505e236bcd" }, { "name": "Retrieve a customer address", "id": "1ed17700-46c3-4fff-95ed-7e34d3a6e7f1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId" ], "variable": [ { "id": "194f4016-8501-4707-acf5-4fcf49c5a669", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a customer address" }, "response": [ { "id": "0e07351c-d8b9-48c1-830f-3f484544703b", "name": "The customer address object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0e07351c-d8b9-48c1-830f-3f484544703b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ed17700-46c3-4fff-95ed-7e34d3a6e7f1" }, { "name": "Update a customer address", "id": "d9c6c6c5-408b-4fc4-997f-4b8111671a0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId" ], "variable": [ { "id": "d25110ad-45f9-4863-9d07-83718792dfc0", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a customer address" }, "response": [ { "id": "2ef9cfeb-2a0b-40f9-9903-94e771b1aeeb", "name": "The updated customer address object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2ef9cfeb-2a0b-40f9-9903-94e771b1aeeb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9c6c6c5-408b-4fc4-997f-4b8111671a0d" }, { "name": "Delete a customer address", "id": "a8ef8a39-6e29-450c-96f2-eda9ee32ebe5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId" ], "variable": [ { "id": "c80144f1-a027-4718-b2ef-7cb5e305afce", "key": "customerAddressId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a customer address" }, "response": [ { "id": "5b35d6c3-e783-4655-bef1-a1ee9d940a50", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses/:customerAddressId", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses", ":customerAddressId" ], "variable": [ { "key": "customerAddressId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5b35d6c3-e783-4655-bef1-a1ee9d940a50" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8ef8a39-6e29-450c-96f2-eda9ee32ebe5" } ], "id": "7dea83ed-a377-450b-8377-e40107edb051", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7dea83ed-a377-450b-8377-e40107edb051" }, { "name": "List all customer addresses", "id": "252dbad3-7853-428b-9789-fe32e0e00dff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_addresses", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses" ] }, "description": "List all customer addresses" }, "response": [ { "id": "2dad50db-dae1-4890-b2cf-ca96fe18fa37", "name": "A list of customer address objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_addresses", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"customer_addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"customer_addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2dad50db-dae1-4890-b2cf-ca96fe18fa37" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-252dbad3-7853-428b-9789-fe32e0e00dff" }, { "name": "Create a customer address", "id": "99cf3d30-3fae-43e7-b552-70db16c74ce2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_addresses\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_addresses", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses" ] }, "description": "Create a customer address" }, "response": [ { "id": "eb50c99e-0c42-4a57-b9f2-fc8bf2ad7a06", "name": "The created customer address object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_addresses\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_addresses", "host": [ "{{baseUrl}}" ], "path": [ "customer_addresses" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_addresses\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-eb50c99e-0c42-4a57-b9f2-fc8bf2ad7a06" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-99cf3d30-3fae-43e7-b552-70db16c74ce2" } ], "id": "48f2b177-edf6-44fb-b99e-c2e1d105f269", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-48f2b177-edf6-44fb-b99e-c2e1d105f269" }, { "name": "customer_groups", "item": [ { "name": "{customerGroupId}", "item": [ { "name": "customers", "item": [ { "name": "Retrieve the customers associated to the customer group", "id": "678aad9e-7ce6-4afd-97b1-4a046e4a0eec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/customers", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "customers" ], "variable": [ { "id": "982bf6fe-7252-4fb6-a0f4-0784fadafef8", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customers associated to the customer group" }, "response": [ { "id": "7c3dfc68-5a12-46a5-bda9-10a33c01024a", "name": "The customers associated to the customer group", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/customers", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "customers" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7c3dfc68-5a12-46a5-bda9-10a33c01024a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-678aad9e-7ce6-4afd-97b1-4a046e4a0eec" } ], "id": "f1d06937-bfab-444a-a814-d205fd94ac7a", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-f1d06937-bfab-444a-a814-d205fd94ac7a" }, { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the customer group", "id": "9c02dde6-5a63-4abb-bfa3-2e0e77c89302", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/markets", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "markets" ], "variable": [ { "id": "e1fd44c4-82c4-4888-8fee-b13f8a31c8e1", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the customer group" }, "response": [ { "id": "6900ceab-83bc-448b-813c-54cca3666370", "name": "The markets associated to the customer group", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/markets", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "markets" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6900ceab-83bc-448b-813c-54cca3666370" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9c02dde6-5a63-4abb-bfa3-2e0e77c89302" } ], "id": "73bbb052-89ba-40dc-ae27-d786dc4519c7", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-73bbb052-89ba-40dc-ae27-d786dc4519c7" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the customer group", "id": "8570de67-1d94-490a-b89b-2ddae5a22104", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "attachments" ], "variable": [ { "id": "ce5b54bb-2014-4447-8c2b-4e05861ed78a", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the customer group" }, "response": [ { "id": "fd6fc6de-89a6-4062-bfe8-5dac3a0d4675", "name": "The attachments associated to the customer group", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "attachments" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fd6fc6de-89a6-4062-bfe8-5dac3a0d4675" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8570de67-1d94-490a-b89b-2ddae5a22104" } ], "id": "c15a38dd-9e9b-4eec-9ab6-11232db3c3d3", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c15a38dd-9e9b-4eec-9ab6-11232db3c3d3" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the customer group", "id": "96f11afe-420c-4fc1-9d82-4eeccbd7b8fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "event_stores" ], "variable": [ { "id": "26130749-81fc-4da7-a54e-0ace5f722e21", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the customer group" }, "response": [ { "id": "b65573b4-55eb-491b-a434-bb1ee26f9685", "name": "The event_stores associated to the customer group", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId", "event_stores" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b65573b4-55eb-491b-a434-bb1ee26f9685" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-96f11afe-420c-4fc1-9d82-4eeccbd7b8fc" } ], "id": "4ab54acd-392b-4a81-b727-4333cca60c13", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-4ab54acd-392b-4a81-b727-4333cca60c13" }, { "name": "Retrieve a customer group", "id": "98a2f275-f6a0-414b-a4eb-446b16b4e0fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId" ], "variable": [ { "id": "d2890177-652e-4851-bfdc-0e5d76967b87", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a customer group" }, "response": [ { "id": "72c4eae8-f468-4dd9-8b77-624865ec414e", "name": "The customer group object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_groups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-72c4eae8-f468-4dd9-8b77-624865ec414e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98a2f275-f6a0-414b-a4eb-446b16b4e0fe" }, { "name": "Update a customer group", "id": "ceb1cf9c-99fa-4cb8-af99-a5de5e65439b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId" ], "variable": [ { "id": "85eda358-4060-4b43-87c7-6da289585535", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a customer group" }, "response": [ { "id": "ea141d68-60e4-4786-90cd-c1cb0fef8403", "name": "The updated customer group object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_groups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ea141d68-60e4-4786-90cd-c1cb0fef8403" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ceb1cf9c-99fa-4cb8-af99-a5de5e65439b" }, { "name": "Delete a customer group", "id": "2d556396-729c-4927-80cf-074619795eae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId" ], "variable": [ { "id": "5512578d-9cce-41a8-a1f3-2a68bd35c0a3", "key": "customerGroupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a customer group" }, "response": [ { "id": "f31f5136-6f7f-4e4d-8aad-6ef5b2e8334b", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups/:customerGroupId", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups", ":customerGroupId" ], "variable": [ { "key": "customerGroupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f31f5136-6f7f-4e4d-8aad-6ef5b2e8334b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d556396-729c-4927-80cf-074619795eae" } ], "id": "7d8134b3-84c2-4594-b686-64bd31d5a86e", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7d8134b3-84c2-4594-b686-64bd31d5a86e" }, { "name": "List all customer groups", "id": "a4d7c48c-de8e-47e4-9b31-ce9b64fe53c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_groups", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups" ] }, "description": "List all customer groups" }, "response": [ { "id": "f0d206c4-c921-416a-842e-c87544b0e9f1", "name": "A list of customer group objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_groups", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"customer_groups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"customer_groups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f0d206c4-c921-416a-842e-c87544b0e9f1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a4d7c48c-de8e-47e4-9b31-ce9b64fe53c0" }, { "name": "Create a customer group", "id": "d4d91963-aacf-4ba5-b5a2-e72a80bc2dbe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_groups\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_groups", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups" ] }, "description": "Create a customer group" }, "response": [ { "id": "7bc7dabc-cc45-4bad-a3c4-ddb8e01e9535", "name": "The created customer group object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_groups\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_groups", "host": [ "{{baseUrl}}" ], "path": [ "customer_groups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_groups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7bc7dabc-cc45-4bad-a3c4-ddb8e01e9535" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d4d91963-aacf-4ba5-b5a2-e72a80bc2dbe" } ], "id": "c6c193eb-c60f-4ad0-9784-c06474e7a6ee", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-c6c193eb-c60f-4ad0-9784-c06474e7a6ee" }, { "name": "customer_password_resets", "item": [ { "name": "{customerPasswordResetId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the customer password reset", "id": "a6c72e27-5f8a-478e-a983-46619bc784d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId", "customer" ], "variable": [ { "id": "f42be636-fd4b-41e8-909d-e59ce6026caa", "key": "customerPasswordResetId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the customer password reset" }, "response": [ { "id": "43bc0bde-cc68-4f8b-967a-58ddc623d681", "name": "The customer associated to the customer password reset", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId", "customer" ], "variable": [ { "key": "customerPasswordResetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-43bc0bde-cc68-4f8b-967a-58ddc623d681" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a6c72e27-5f8a-478e-a983-46619bc784d5" } ], "id": "34746e2a-74be-4bcd-a581-86c019706c7b", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-34746e2a-74be-4bcd-a581-86c019706c7b" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the customer password reset", "id": "314b2602-7914-465c-bc60-c9e98c0d2249", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId/events", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId", "events" ], "variable": [ { "id": "8a82536b-6375-4cbb-a54a-fa5c4ac928bf", "key": "customerPasswordResetId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the customer password reset" }, "response": [ { "id": "a3cdec5e-829e-4e50-82bc-7e173b2357da", "name": "The events associated to the customer password reset", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId/events", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId", "events" ], "variable": [ { "key": "customerPasswordResetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a3cdec5e-829e-4e50-82bc-7e173b2357da" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-314b2602-7914-465c-bc60-c9e98c0d2249" } ], "id": "7d550eb8-4fac-4765-8472-86d40d0d7a5e", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-7d550eb8-4fac-4765-8472-86d40d0d7a5e" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the customer password reset", "id": "785f3087-0bb3-46d3-a2ac-3a2b5dc67189", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId", "event_stores" ], "variable": [ { "id": "4e89ec8c-c0bc-42e1-8659-47ce7918983a", "key": "customerPasswordResetId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the customer password reset" }, "response": [ { "id": "67a154dc-d307-4a15-b295-49bbdaad28a7", "name": "The event_stores associated to the customer password reset", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId", "event_stores" ], "variable": [ { "key": "customerPasswordResetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-67a154dc-d307-4a15-b295-49bbdaad28a7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-785f3087-0bb3-46d3-a2ac-3a2b5dc67189" } ], "id": "008080e3-a4c2-4c52-846c-509ab69bdc02", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-008080e3-a4c2-4c52-846c-509ab69bdc02" }, { "name": "Retrieve a customer password reset", "id": "90664d12-55a3-4d3f-9293-753be85e49ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId" ], "variable": [ { "id": "f036b641-1778-483e-98e0-c0f5d7bc8406", "key": "customerPasswordResetId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a customer password reset" }, "response": [ { "id": "df39f044-04a1-4479-973e-5de453f2f507", "name": "The customer password reset object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId" ], "variable": [ { "key": "customerPasswordResetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_password_resets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reset_password_token\": \"\",\n \"reset_password_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df39f044-04a1-4479-973e-5de453f2f507" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-90664d12-55a3-4d3f-9293-753be85e49ff" }, { "name": "Update a customer password reset", "id": "d77fd58d-3e4b-47c5-8a9f-21133a1a9789", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_password_resets\",\n \"id\": \"\",\n \"attributes\": {\n \"customer_password\": \"\",\n \"_reset_password_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId" ], "variable": [ { "id": "679bafdd-05d1-425a-8c94-88d0a613b68e", "key": "customerPasswordResetId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a customer password reset" }, "response": [ { "id": "9ae8c278-9df2-4f4a-a1c4-665aff3e907d", "name": "The updated customer password reset object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_password_resets\",\n \"id\": \"\",\n \"attributes\": {\n \"customer_password\": \"\",\n \"_reset_password_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId" ], "variable": [ { "key": "customerPasswordResetId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_password_resets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reset_password_token\": \"\",\n \"reset_password_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9ae8c278-9df2-4f4a-a1c4-665aff3e907d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d77fd58d-3e4b-47c5-8a9f-21133a1a9789" }, { "name": "Delete a customer password reset", "id": "1dd0479f-5661-4096-a93c-bb927635a522", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId" ], "variable": [ { "id": "e4fd6379-1c34-4e83-920d-d33447e9bd24", "key": "customerPasswordResetId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a customer password reset" }, "response": [ { "id": "c7f6187a-bb8b-4bea-9716-235354e4e518", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_password_resets/:customerPasswordResetId", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets", ":customerPasswordResetId" ], "variable": [ { "key": "customerPasswordResetId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c7f6187a-bb8b-4bea-9716-235354e4e518" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1dd0479f-5661-4096-a93c-bb927635a522" } ], "id": "0b9975a8-303a-4e68-bc8a-c7309e8c94e8", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-0b9975a8-303a-4e68-bc8a-c7309e8c94e8" }, { "name": "List all customer password resets", "id": "636668b2-0816-422b-b864-510b33530831", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_password_resets", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets" ] }, "description": "List all customer password resets" }, "response": [ { "id": "9136c810-5165-4524-a12b-3037231bdbe8", "name": "A list of customer password reset objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_password_resets", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"customer_password_resets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reset_password_token\": \"\",\n \"reset_password_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"customer_password_resets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reset_password_token\": \"\",\n \"reset_password_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9136c810-5165-4524-a12b-3037231bdbe8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-636668b2-0816-422b-b864-510b33530831" }, { "name": "Create a customer password reset", "id": "48afcc00-36da-4d6b-9cc7-c899d7c00ecf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_password_resets\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_password_resets", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets" ] }, "description": "Create a customer password reset" }, "response": [ { "id": "b221869d-527e-4fb5-9e53-47099bfc6141", "name": "The created customer password reset object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_password_resets\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_password_resets", "host": [ "{{baseUrl}}" ], "path": [ "customer_password_resets" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_password_resets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reset_password_token\": \"\",\n \"reset_password_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b221869d-527e-4fb5-9e53-47099bfc6141" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-48afcc00-36da-4d6b-9cc7-c899d7c00ecf" } ], "id": "de1bfbb9-b8de-4c85-89cf-321c34b51cc5", "createdAt": "2026-06-05T15:07:13.000Z", "updatedAt": "2026-06-05T15:07:13.000Z", "uid": "35240-de1bfbb9-b8de-4c85-89cf-321c34b51cc5" }, { "name": "customer_payment_sources", "item": [ { "name": "{customerPaymentSourceId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the customer payment source", "id": "196066f4-20c0-44f3-96d9-31351d8a9a76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId", "customer" ], "variable": [ { "id": "d2e1c7ef-1677-42b6-93e1-1c80ba508dab", "key": "customerPaymentSourceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the customer payment source" }, "response": [ { "id": "f76fe0e5-2d2a-4f39-be5e-dbde0b2278fb", "name": "The customer associated to the customer payment source", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId", "customer" ], "variable": [ { "key": "customerPaymentSourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f76fe0e5-2d2a-4f39-be5e-dbde0b2278fb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-196066f4-20c0-44f3-96d9-31351d8a9a76" } ], "id": "a800d5d2-ad67-4e3a-be7f-aa06d427beac", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a800d5d2-ad67-4e3a-be7f-aa06d427beac" }, { "name": "payment_method", "item": [ { "name": "Retrieve the payment method associated to the customer payment source", "id": "bcdb4e86-7266-47e4-9a85-10c66eb1e41e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId/payment_method", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId", "payment_method" ], "variable": [ { "id": "45e63f64-d925-4e50-ba42-f86883f595e0", "key": "customerPaymentSourceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment method associated to the customer payment source" }, "response": [ { "id": "0a603b54-137d-47a5-a6f7-e81e046f2ad0", "name": "The payment_method associated to the customer payment source", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId/payment_method", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId", "payment_method" ], "variable": [ { "key": "customerPaymentSourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0a603b54-137d-47a5-a6f7-e81e046f2ad0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bcdb4e86-7266-47e4-9a85-10c66eb1e41e" } ], "id": "5f03c0e5-215b-4a4c-b617-9457b317c20b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5f03c0e5-215b-4a4c-b617-9457b317c20b" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the customer payment source", "id": "899b1494-ff11-4f13-ba06-2d1dce5e043c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId", "event_stores" ], "variable": [ { "id": "3e9696b2-4703-49a7-a08b-44d51b933588", "key": "customerPaymentSourceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the customer payment source" }, "response": [ { "id": "50543071-d3c2-4da0-8817-8c94a7f3940f", "name": "The event_stores associated to the customer payment source", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId", "event_stores" ], "variable": [ { "key": "customerPaymentSourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-50543071-d3c2-4da0-8817-8c94a7f3940f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-899b1494-ff11-4f13-ba06-2d1dce5e043c" } ], "id": "72e35a18-928b-4b3a-a4c4-c66379d29f06", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-72e35a18-928b-4b3a-a4c4-c66379d29f06" }, { "name": "Retrieve a customer payment source", "id": "72941658-a937-41c3-8713-a3ada4a85a7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId" ], "variable": [ { "id": "ac3b301a-62e9-4915-9c39-c4c5e126daa6", "key": "customerPaymentSourceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a customer payment source" }, "response": [ { "id": "81806715-283b-45cd-ba68-5d4c2274f7f7", "name": "The customer payment source object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId" ], "variable": [ { "key": "customerPaymentSourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_payment_sources\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-81806715-283b-45cd-ba68-5d4c2274f7f7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-72941658-a937-41c3-8713-a3ada4a85a7c" }, { "name": "Update a customer payment source", "id": "5bf93403-cf47-4a70-8bc7-76b63ce1a068", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\",\n \"attributes\": {\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId" ], "variable": [ { "id": "579729ca-ad06-4150-9786-1bb8b822da00", "key": "customerPaymentSourceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a customer payment source" }, "response": [ { "id": "aed2984c-7a65-4e5f-8be3-5bf7ac9a07ad", "name": "The updated customer payment source object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\",\n \"attributes\": {\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId" ], "variable": [ { "key": "customerPaymentSourceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_payment_sources\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aed2984c-7a65-4e5f-8be3-5bf7ac9a07ad" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5bf93403-cf47-4a70-8bc7-76b63ce1a068" }, { "name": "Delete a customer payment source", "id": "8385ba86-8a6a-4112-ab15-43419a04499f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId" ], "variable": [ { "id": "0aa9e761-2a32-4702-b72d-9672d9867aa3", "key": "customerPaymentSourceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a customer payment source" }, "response": [ { "id": "7c734ad6-8eda-4595-b187-2f227ba569fb", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources/:customerPaymentSourceId", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources", ":customerPaymentSourceId" ], "variable": [ { "key": "customerPaymentSourceId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7c734ad6-8eda-4595-b187-2f227ba569fb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8385ba86-8a6a-4112-ab15-43419a04499f" } ], "id": "ea4a524e-b139-4d06-a6b0-b88334a14a2d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ea4a524e-b139-4d06-a6b0-b88334a14a2d" }, { "name": "List all customer payment sources", "id": "4208cb53-9d5e-451a-ad29-ee69196a8a61", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources" ] }, "description": "List all customer payment sources" }, "response": [ { "id": "97056a0e-4c0a-43cb-a8f2-5d541e3455e8", "name": "A list of customer payment source objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"customer_payment_sources\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"customer_payment_sources\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-97056a0e-4c0a-43cb-a8f2-5d541e3455e8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4208cb53-9d5e-451a-ad29-ee69196a8a61" }, { "name": "Create a customer payment source", "id": "61745638-7105-478e-a8a1-891fdcb23dbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"attributes\": {\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources" ] }, "description": "Create a customer payment source" }, "response": [ { "id": "8dd14929-f1fb-4ba9-84a9-0b09979eebf9", "name": "The created customer payment source object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"attributes\": {\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "customer_payment_sources" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_payment_sources\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"customer_token\": \"\",\n \"payment_source_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8dd14929-f1fb-4ba9-84a9-0b09979eebf9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-61745638-7105-478e-a8a1-891fdcb23dbd" } ], "id": "34899db7-71a1-464f-baee-ea468c10dee6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-34899db7-71a1-464f-baee-ea468c10dee6" }, { "name": "customer_subscriptions", "item": [ { "name": "{customerSubscriptionId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the customer subscription", "id": "8d81f967-c2b8-4c99-a65b-2a345a29b674", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId", "customer" ], "variable": [ { "id": "ef2f181f-ceee-4d94-86f3-6e296aa03d71", "key": "customerSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the customer subscription" }, "response": [ { "id": "cf32cbe9-aa9c-461d-856c-aff18c958689", "name": "The customer associated to the customer subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId/customer", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId", "customer" ], "variable": [ { "key": "customerSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cf32cbe9-aa9c-461d-856c-aff18c958689" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8d81f967-c2b8-4c99-a65b-2a345a29b674" } ], "id": "28ff83ef-52a0-40a8-b2dc-d142730f95b1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-28ff83ef-52a0-40a8-b2dc-d142730f95b1" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the customer subscription", "id": "233b2893-82d3-49b3-ba8c-ab6dee0399f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId", "events" ], "variable": [ { "id": "6bf4d66d-d333-475e-83fe-7dbef306ca58", "key": "customerSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the customer subscription" }, "response": [ { "id": "cc5e0bfe-d97f-4c9d-aad9-d3490b89f402", "name": "The events associated to the customer subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId", "events" ], "variable": [ { "key": "customerSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cc5e0bfe-d97f-4c9d-aad9-d3490b89f402" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-233b2893-82d3-49b3-ba8c-ab6dee0399f6" } ], "id": "f3ddf2ab-d3e3-49c3-b212-9050d4966a84", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f3ddf2ab-d3e3-49c3-b212-9050d4966a84" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the customer subscription", "id": "d64d9450-ef90-4c67-8676-7b417e1ec2af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId", "event_stores" ], "variable": [ { "id": "f6a55bf4-d304-499b-a235-29b261c345a8", "key": "customerSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the customer subscription" }, "response": [ { "id": "d01fbb43-cd73-4653-b22a-0cc668caf6ea", "name": "The event_stores associated to the customer subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId", "event_stores" ], "variable": [ { "key": "customerSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d01fbb43-cd73-4653-b22a-0cc668caf6ea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d64d9450-ef90-4c67-8676-7b417e1ec2af" } ], "id": "c3a42949-955f-48c7-bd80-b5ceb60021ad", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c3a42949-955f-48c7-bd80-b5ceb60021ad" }, { "name": "Retrieve a customer subscription", "id": "377a5b89-d98d-4e09-8968-63dfb3020d45", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId" ], "variable": [ { "id": "443a06ae-8ea4-4f5b-bc50-35f31f5f95b1", "key": "customerSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a customer subscription" }, "response": [ { "id": "da65c10c-bfd0-490e-ac66-26de4165505e", "name": "The customer subscription object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId" ], "variable": [ { "key": "customerSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-da65c10c-bfd0-490e-ac66-26de4165505e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-377a5b89-d98d-4e09-8968-63dfb3020d45" }, { "name": "Update a customer subscription", "id": "e5f9a11d-bd3d-44ab-a033-81327dd7383e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId" ], "variable": [ { "id": "85b76dc9-d128-48c3-b01f-fc60556a714a", "key": "customerSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a customer subscription" }, "response": [ { "id": "cda93039-a3af-45ff-8587-3713a7ec1722", "name": "The updated customer subscription object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId" ], "variable": [ { "key": "customerSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cda93039-a3af-45ff-8587-3713a7ec1722" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5f9a11d-bd3d-44ab-a033-81327dd7383e" }, { "name": "Delete a customer subscription", "id": "c9773592-ba6e-4882-9b85-85c19f9107ca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId" ], "variable": [ { "id": "5d4feb0f-275d-49ea-b465-554673f0dfe0", "key": "customerSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a customer subscription" }, "response": [ { "id": "2b40523f-8593-4bb2-8656-d0aad84e0de6", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions/:customerSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions", ":customerSubscriptionId" ], "variable": [ { "key": "customerSubscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2b40523f-8593-4bb2-8656-d0aad84e0de6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c9773592-ba6e-4882-9b85-85c19f9107ca" } ], "id": "43e5159d-c7d5-4b70-8b38-0a86b8e05a93", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-43e5159d-c7d5-4b70-8b38-0a86b8e05a93" }, { "name": "List all customer subscriptions", "id": "c2bcf594-4519-4f69-9496-eba7b4636f63", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions" ] }, "description": "List all customer subscriptions" }, "response": [ { "id": "ecbcb0c0-20cf-4764-a3df-d3c511fc9f5c", "name": "A list of customer subscription objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customer_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"customer_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"customer_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ecbcb0c0-20cf-4764-a3df-d3c511fc9f5c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c2bcf594-4519-4f69-9496-eba7b4636f63" }, { "name": "Create a customer subscription", "id": "deb81081-5a0b-4115-95d4-553dcc2f6e70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions" ] }, "description": "Create a customer subscription" }, "response": [ { "id": "a9d01d73-a53c-43b2-ad80-cb9f84ffc535", "name": "The created customer subscription object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customer_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customer_subscriptions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customer_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"customer_email\": \"\",\n \"reference\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a9d01d73-a53c-43b2-ad80-cb9f84ffc535" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-deb81081-5a0b-4115-95d4-553dcc2f6e70" } ], "id": "fa24fb44-da90-439f-a8dd-a767c1018266", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fa24fb44-da90-439f-a8dd-a767c1018266" }, { "name": "customers", "item": [ { "name": "{customerId}", "item": [ { "name": "customer_group", "item": [ { "name": "Retrieve the customer group associated to the customer", "id": "324c6c63-b394-487a-b592-c13242813a4e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_group", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_group" ], "variable": [ { "id": "db811a2e-ca42-4577-bf46-00c2a2ff1458", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer group associated to the customer" }, "response": [ { "id": "5b2d3510-0258-4fd1-a7e2-3985f4361ae5", "name": "The customer_group associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_group", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_group" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5b2d3510-0258-4fd1-a7e2-3985f4361ae5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-324c6c63-b394-487a-b592-c13242813a4e" } ], "id": "b974dbac-a0fc-4245-a8ee-cb055e59baf8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b974dbac-a0fc-4245-a8ee-cb055e59baf8" }, { "name": "customer_addresses", "item": [ { "name": "Retrieve the customer addresses associated to the customer", "id": "d4cbbec3-32d4-42b0-96ca-84a13bb69666", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_addresses", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_addresses" ], "variable": [ { "id": "77a71da8-0f73-4c17-8e47-ed320d988478", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer addresses associated to the customer" }, "response": [ { "id": "6850d879-4053-4a74-93c2-1c14a7c4b306", "name": "The customer_addresses associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_addresses", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_addresses" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6850d879-4053-4a74-93c2-1c14a7c4b306" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d4cbbec3-32d4-42b0-96ca-84a13bb69666" } ], "id": "3deb52fb-d443-46d8-8fe1-d08f974220c5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3deb52fb-d443-46d8-8fe1-d08f974220c5" }, { "name": "customer_payment_sources", "item": [ { "name": "Retrieve the customer payment sources associated to the customer", "id": "ae7b8c60-71ac-48f7-a505-721c4b149823", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_payment_sources" ], "variable": [ { "id": "ed86fbf4-42ca-421d-84fb-97a582e8b17d", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer payment sources associated to the customer" }, "response": [ { "id": "3fa7e0b5-405a-4e8e-97b1-b6fd0a1b33b6", "name": "The customer_payment_sources associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_payment_sources" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3fa7e0b5-405a-4e8e-97b1-b6fd0a1b33b6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ae7b8c60-71ac-48f7-a505-721c4b149823" } ], "id": "7a6f0b1d-1ff0-4349-9caa-bc265bca738b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7a6f0b1d-1ff0-4349-9caa-bc265bca738b" }, { "name": "customer_subscriptions", "item": [ { "name": "Retrieve the customer subscriptions associated to the customer", "id": "ac432a04-72da-4b20-8e57-4be7f783da4e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_subscriptions" ], "variable": [ { "id": "1ac9c159-a3cc-42dc-bbe0-d4ade18eaa13", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer subscriptions associated to the customer" }, "response": [ { "id": "6004a8b3-08a5-4e93-85da-fa1810e12a92", "name": "The customer_subscriptions associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/customer_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "customer_subscriptions" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6004a8b3-08a5-4e93-85da-fa1810e12a92" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ac432a04-72da-4b20-8e57-4be7f783da4e" } ], "id": "78ec68d1-cf85-4986-8766-34ed58a7d253", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-78ec68d1-cf85-4986-8766-34ed58a7d253" }, { "name": "orders", "item": [ { "name": "Retrieve the orders associated to the customer", "id": "2d715ab7-5167-480a-9e34-bbe43b3394d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/orders", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "orders" ], "variable": [ { "id": "24bb096c-b2ad-4ca6-a86c-ffb1084527b5", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the orders associated to the customer" }, "response": [ { "id": "f61481d0-2b34-47b2-9a08-ccf8f6559f73", "name": "The orders associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/orders", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "orders" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f61481d0-2b34-47b2-9a08-ccf8f6559f73" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d715ab7-5167-480a-9e34-bbe43b3394d1" } ], "id": "7f4cde3d-1e38-458d-96aa-a96e89001208", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7f4cde3d-1e38-458d-96aa-a96e89001208" }, { "name": "order_subscriptions", "item": [ { "name": "Retrieve the order subscriptions associated to the customer", "id": "1e7e7307-68b2-48ce-afb9-48e230390dc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "order_subscriptions" ], "variable": [ { "id": "07b2200d-445d-4a3f-a7d1-713740c0c146", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscriptions associated to the customer" }, "response": [ { "id": "f30f67b7-ebd4-4b72-9afa-2188989f4962", "name": "The order_subscriptions associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "order_subscriptions" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f30f67b7-ebd4-4b72-9afa-2188989f4962" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1e7e7307-68b2-48ce-afb9-48e230390dc1" } ], "id": "97b5f165-f945-4424-a15c-1d0b00cbad4e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-97b5f165-f945-4424-a15c-1d0b00cbad4e" }, { "name": "returns", "item": [ { "name": "Retrieve the returns associated to the customer", "id": "f9b85e15-95c6-4e75-9709-049716147fd6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/returns", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "returns" ], "variable": [ { "id": "0d0f240d-0b72-4f00-99b5-dbff97128447", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the returns associated to the customer" }, "response": [ { "id": "28b68efe-b1f9-483f-89e0-2a79ce4c92c0", "name": "The returns associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/returns", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "returns" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-28b68efe-b1f9-483f-89e0-2a79ce4c92c0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f9b85e15-95c6-4e75-9709-049716147fd6" } ], "id": "f8520366-728e-4652-b489-f8fb08946c94", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f8520366-728e-4652-b489-f8fb08946c94" }, { "name": "sku_lists", "item": [ { "name": "Retrieve the sku lists associated to the customer", "id": "ba790ca4-90e9-4e3e-81c2-758adf4d4020", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "sku_lists" ], "variable": [ { "id": "8f728993-ec48-46d7-ac69-b9d72e372f0d", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku lists associated to the customer" }, "response": [ { "id": "bd872d59-c3cb-49e5-916f-3c0826b05e9e", "name": "The sku_lists associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "sku_lists" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bd872d59-c3cb-49e5-916f-3c0826b05e9e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba790ca4-90e9-4e3e-81c2-758adf4d4020" } ], "id": "dd974dec-ad23-44ab-b981-0ab649beb805", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dd974dec-ad23-44ab-b981-0ab649beb805" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the customer", "id": "3e381e87-a0fe-44ec-89e6-f579655289dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "attachments" ], "variable": [ { "id": "49a7baa3-a164-4b81-9f40-e3620eaa6cf8", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the customer" }, "response": [ { "id": "607b5f84-53f8-430e-9974-94d1d1e2aae8", "name": "The attachments associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "attachments" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-607b5f84-53f8-430e-9974-94d1d1e2aae8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3e381e87-a0fe-44ec-89e6-f579655289dc" } ], "id": "caf9a817-90ae-49b3-b80b-aa5e8c73124c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-caf9a817-90ae-49b3-b80b-aa5e8c73124c" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the customer", "id": "6363bb95-5f81-4268-aed0-270fbca589a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/events", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "events" ], "variable": [ { "id": "7d0f80f9-0059-4466-bf56-2134de7a745c", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the customer" }, "response": [ { "id": "1b55c223-8f7e-4337-84fc-09a945ea5d87", "name": "The events associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/events", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "events" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1b55c223-8f7e-4337-84fc-09a945ea5d87" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6363bb95-5f81-4268-aed0-270fbca589a0" } ], "id": "57f6e62b-6496-4dd6-9a74-63811dc73f71", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-57f6e62b-6496-4dd6-9a74-63811dc73f71" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the customer", "id": "c131e31e-d783-4e14-acc1-9ce0c7c60820", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/tags", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "tags" ], "variable": [ { "id": "a6687909-a5b8-4aaf-ba38-710f3e10bb26", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the customer" }, "response": [ { "id": "0852462f-721a-436d-b85e-8d8649323c72", "name": "The tags associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/tags", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "tags" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0852462f-721a-436d-b85e-8d8649323c72" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c131e31e-d783-4e14-acc1-9ce0c7c60820" } ], "id": "b0f12429-80c9-4616-a939-03e08406c2a0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b0f12429-80c9-4616-a939-03e08406c2a0" }, { "name": "jwt_customer", "item": [ { "name": "Retrieve the jwt customer associated to the customer", "id": "73a2f4d3-818f-4c92-9468-3a65845dd16d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/jwt_customer", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "jwt_customer" ], "variable": [ { "id": "7bdb497d-abf3-47be-95f0-4fcddbefea3a", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt customer associated to the customer" }, "response": [ { "id": "42ead39a-c35d-44ed-82bc-07baf4fa491c", "name": "The jwt_customer associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/jwt_customer", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "jwt_customer" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-42ead39a-c35d-44ed-82bc-07baf4fa491c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-73a2f4d3-818f-4c92-9468-3a65845dd16d" } ], "id": "4be6059e-18e7-4414-852a-161835892de5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4be6059e-18e7-4414-852a-161835892de5" }, { "name": "jwt_markets", "item": [ { "name": "Retrieve the jwt markets associated to the customer", "id": "1c646cbd-e3a7-464f-9469-f1accac0ccac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/jwt_markets", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "jwt_markets" ], "variable": [ { "id": "7c151526-9a89-439d-a88c-f6328da60911", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt markets associated to the customer" }, "response": [ { "id": "36c980dc-ec4c-47fb-a7d7-55c72c7f028d", "name": "The jwt_markets associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/jwt_markets", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "jwt_markets" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-36c980dc-ec4c-47fb-a7d7-55c72c7f028d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1c646cbd-e3a7-464f-9469-f1accac0ccac" } ], "id": "083b43ba-adca-4b6c-bd98-78714d414784", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-083b43ba-adca-4b6c-bd98-78714d414784" }, { "name": "jwt_stock_locations", "item": [ { "name": "Retrieve the jwt stock locations associated to the customer", "id": "2393417a-6974-4886-903e-11585c722f3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/jwt_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "jwt_stock_locations" ], "variable": [ { "id": "29f6995f-ed7f-435b-8861-48717fe12f0d", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt stock locations associated to the customer" }, "response": [ { "id": "066056fc-69a3-4c44-9270-460944341bda", "name": "The jwt_stock_locations associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/jwt_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "jwt_stock_locations" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-066056fc-69a3-4c44-9270-460944341bda" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2393417a-6974-4886-903e-11585c722f3c" } ], "id": "c2f667d4-3d80-4065-b16f-dd79a227c870", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c2f667d4-3d80-4065-b16f-dd79a227c870" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the customer", "id": "daa1e823-c92e-481b-b758-0c25f8694dca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "event_stores" ], "variable": [ { "id": "ff09b107-d468-4b40-bbd2-6a18f8807128", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the customer" }, "response": [ { "id": "f3d408a9-e71f-409e-9928-801dbdf53500", "name": "The event_stores associated to the customer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId", "event_stores" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f3d408a9-e71f-409e-9928-801dbdf53500" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-daa1e823-c92e-481b-b758-0c25f8694dca" } ], "id": "068f24c3-e373-411c-a76b-6f7e3cb52b6b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-068f24c3-e373-411c-a76b-6f7e3cb52b6b" }, { "name": "Retrieve a customer", "id": "9e8881bf-434a-44d1-9a86-ae5c16be8e6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "id": "732ee46e-7d27-470d-b671-03acfa99f308", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a customer" }, "response": [ { "id": "7cd17da5-4210-4461-966c-415fb6e064e4", "name": "The customer object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"status\": \"prospect\",\n \"has_password\": \"\",\n \"total_orders_count\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {},\n \"anonymization_info\": {\n \"status\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"cancelled_at\": \"\",\n \"requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n },\n \"cancellation_requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n },\n \"anonymization_status\": \"completed\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"customer_addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\"\n }\n },\n \"customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"customer_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7cd17da5-4210-4461-966c-415fb6e064e4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9e8881bf-434a-44d1-9a86-ae5c16be8e6f" }, { "name": "Update a customer", "id": "b6806920-f50e-49c8-a4a7-0847a1f12fd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\",\n \"attributes\": {\n \"email\": \"\",\n \"password\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_request_anonymization\": \"\",\n \"_cancel_anonymization\": \"\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "id": "4b5a8189-0211-435f-ac15-9ebaab620d03", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a customer" }, "response": [ { "id": "b0ef24d9-fd9f-4ca2-9032-0d9c08ea387e", "name": "The updated customer object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\",\n \"attributes\": {\n \"email\": \"\",\n \"password\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_request_anonymization\": \"\",\n \"_cancel_anonymization\": \"\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"status\": \"prospect\",\n \"has_password\": \"\",\n \"total_orders_count\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {},\n \"anonymization_info\": {\n \"status\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"cancelled_at\": \"\",\n \"requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n },\n \"cancellation_requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n },\n \"anonymization_status\": \"completed\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"customer_addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\"\n }\n },\n \"customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"customer_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b0ef24d9-fd9f-4ca2-9032-0d9c08ea387e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b6806920-f50e-49c8-a4a7-0847a1f12fd5" }, { "name": "Delete a customer", "id": "9d7cd5ef-2495-44cf-9f45-3760682712d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "id": "09372b00-2c36-460c-9970-11b203ec2a2e", "key": "customerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a customer" }, "response": [ { "id": "5d7430b3-76a3-4cf5-959f-dcb01528c69a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers/:customerId", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customerId" ], "variable": [ { "key": "customerId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5d7430b3-76a3-4cf5-959f-dcb01528c69a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9d7cd5ef-2495-44cf-9f45-3760682712d0" } ], "id": "41d28a3c-c118-4e03-b832-027e3ef42581", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-41d28a3c-c118-4e03-b832-027e3ef42581" }, { "name": "List all customers", "id": "5e883aaf-a453-4014-ab55-6f1297f4e01f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] }, "description": "List all customers" }, "response": [ { "id": "43b8554c-7f52-4ccf-be25-9198beee8dc7", "name": "A list of customer objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"customers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"status\": \"prospect\",\n \"has_password\": \"\",\n \"total_orders_count\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {},\n \"anonymization_info\": {\n \"status\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"cancelled_at\": \"\",\n \"requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n },\n \"cancellation_requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n },\n \"anonymization_status\": \"cancelled\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"customer_addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\"\n }\n },\n \"customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"customer_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"customers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"status\": \"prospect\",\n \"has_password\": \"\",\n \"total_orders_count\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {},\n \"anonymization_info\": {\n \"status\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"cancelled_at\": \"\",\n \"requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n },\n \"cancellation_requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n },\n \"anonymization_status\": \"failed\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"customer_addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\"\n }\n },\n \"customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"customer_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-43b8554c-7f52-4ccf-be25-9198beee8dc7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5e883aaf-a453-4014-ab55-6f1297f4e01f" }, { "name": "Create a customer", "id": "35c9e48a-08fe-4aca-be0d-56c7a103b191", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customers\",\n \"attributes\": {\n \"email\": \"\",\n \"password\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] }, "description": "Create a customer" }, "response": [ { "id": "1e598180-a88a-4b18-8f3c-d190c726b335", "name": "The created customer object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"customers\",\n \"attributes\": {\n \"email\": \"\",\n \"password\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/customers", "host": [ "{{baseUrl}}" ], "path": [ "customers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"customers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"status\": \"prospect\",\n \"has_password\": \"\",\n \"total_orders_count\": \"\",\n \"shopper_reference\": \"\",\n \"profile_id\": \"\",\n \"tax_exemption_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {},\n \"anonymization_info\": {\n \"status\": \"\",\n \"requested_at\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"cancelled_at\": \"\",\n \"requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n },\n \"cancellation_requester\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\"\n }\n },\n \"anonymization_status\": \"completed\"\n },\n \"relationships\": {\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"customer_addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_addresses\",\n \"id\": \"\"\n }\n },\n \"customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"customer_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_subscriptions\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1e598180-a88a-4b18-8f3c-d190c726b335" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-35c9e48a-08fe-4aca-be0d-56c7a103b191" } ], "id": "0b2fd99f-a6ae-49a7-93f1-7477cec081cb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0b2fd99f-a6ae-49a7-93f1-7477cec081cb" }, { "name": "delivery_lead_times", "item": [ { "name": "{deliveryLeadTimeId}", "item": [ { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the delivery lead time", "id": "07a622ac-b9f9-4867-b8f0-7a02692de153", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "stock_location" ], "variable": [ { "id": "35714b4b-ca53-46dd-b201-ffc8df84887e", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the delivery lead time" }, "response": [ { "id": "7859242b-76bd-4444-bd5c-5a34ec2a6806", "name": "The stock_location associated to the delivery lead time", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "stock_location" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7859242b-76bd-4444-bd5c-5a34ec2a6806" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07a622ac-b9f9-4867-b8f0-7a02692de153" } ], "id": "c7ef0f1b-195c-4bbd-97d9-9d5b3eea4781", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c7ef0f1b-195c-4bbd-97d9-9d5b3eea4781" }, { "name": "shipping_method", "item": [ { "name": "Retrieve the shipping method associated to the delivery lead time", "id": "7c03f950-b551-45c3-b5e4-feabb20397d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "shipping_method" ], "variable": [ { "id": "ab72dac1-0fb3-4b58-ad24-c20e637e7877", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping method associated to the delivery lead time" }, "response": [ { "id": "8f49d050-caaf-406e-8796-3b0eba4464a9", "name": "The shipping_method associated to the delivery lead time", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "shipping_method" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8f49d050-caaf-406e-8796-3b0eba4464a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7c03f950-b551-45c3-b5e4-feabb20397d1" } ], "id": "77267ce1-cf4b-4e7a-8e0b-3838154fbe63", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-77267ce1-cf4b-4e7a-8e0b-3838154fbe63" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the delivery lead time", "id": "ba5e391f-7f3f-4d2e-bb67-e4d307b9f128", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "attachments" ], "variable": [ { "id": "96e8188a-50ac-4a04-8665-c00b08f6314f", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the delivery lead time" }, "response": [ { "id": "3598b51a-4323-4c51-9728-5c72a6d87cb9", "name": "The attachments associated to the delivery lead time", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "attachments" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3598b51a-4323-4c51-9728-5c72a6d87cb9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba5e391f-7f3f-4d2e-bb67-e4d307b9f128" } ], "id": "7545b0ff-9ce3-47c3-8117-c68c90fa9de0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7545b0ff-9ce3-47c3-8117-c68c90fa9de0" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the delivery lead time", "id": "1b2ee6c9-3ee4-4853-bcdb-a71ab469b6b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "event_stores" ], "variable": [ { "id": "6ca6e0d2-a000-4d4f-afce-a27b573d76ba", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the delivery lead time" }, "response": [ { "id": "f425bcf4-25e5-4243-9993-04ff99362c1e", "name": "The event_stores associated to the delivery lead time", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId", "event_stores" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f425bcf4-25e5-4243-9993-04ff99362c1e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1b2ee6c9-3ee4-4853-bcdb-a71ab469b6b5" } ], "id": "758d5a68-ab61-48e8-a0a5-fb4749c0f16e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-758d5a68-ab61-48e8-a0a5-fb4749c0f16e" }, { "name": "Retrieve a delivery lead time", "id": "45df58b4-c1ed-45b4-9c52-98e84cc530d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId" ], "variable": [ { "id": "eb90573b-e57b-45d8-a88c-8edd44cf42fd", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a delivery lead time" }, "response": [ { "id": "63502aa1-8dad-4199-afc2-4c4fb2de359a", "name": "The delivery lead time object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"delivery_lead_times\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-63502aa1-8dad-4199-afc2-4c4fb2de359a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-45df58b4-c1ed-45b4-9c52-98e84cc530d2" }, { "name": "Update a delivery lead time", "id": "d2843693-687b-4c92-a45f-04865a0651fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\",\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId" ], "variable": [ { "id": "715e8d11-bffe-43a9-8683-409eec3a0b61", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a delivery lead time" }, "response": [ { "id": "cbf0513b-39e0-4626-bb84-4e4e4062f8d3", "name": "The updated delivery lead time object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\",\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"delivery_lead_times\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cbf0513b-39e0-4626-bb84-4e4e4062f8d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d2843693-687b-4c92-a45f-04865a0651fc" }, { "name": "Delete a delivery lead time", "id": "9a39c776-6f52-4554-ba84-cd9d855c8c02", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId" ], "variable": [ { "id": "a490e4b6-1150-4afd-9119-7e7c55435eea", "key": "deliveryLeadTimeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a delivery lead time" }, "response": [ { "id": "5186f40a-ac81-45f6-a073-427c974018a9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times/:deliveryLeadTimeId", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times", ":deliveryLeadTimeId" ], "variable": [ { "key": "deliveryLeadTimeId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5186f40a-ac81-45f6-a073-427c974018a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9a39c776-6f52-4554-ba84-cd9d855c8c02" } ], "id": "b1ed3d81-e45c-401e-bf5b-22509df506d5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b1ed3d81-e45c-401e-bf5b-22509df506d5" }, { "name": "List all delivery lead times", "id": "70fdb86b-5436-48d8-8bed-b15d19c7ee66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times" ] }, "description": "List all delivery lead times" }, "response": [ { "id": "b48dfa20-9385-4924-a3b0-6560c5d3eba7", "name": "A list of delivery lead time objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/delivery_lead_times", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"delivery_lead_times\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"delivery_lead_times\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b48dfa20-9385-4924-a3b0-6560c5d3eba7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-70fdb86b-5436-48d8-8bed-b15d19c7ee66" }, { "name": "Create a delivery lead time", "id": "9463a450-53dd-436e-9918-51c75c0a8dae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/delivery_lead_times", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times" ] }, "description": "Create a delivery lead time" }, "response": [ { "id": "bde5fe53-6ad4-4607-aca5-0484b42b8e2d", "name": "The created delivery lead time object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/delivery_lead_times", "host": [ "{{baseUrl}}" ], "path": [ "delivery_lead_times" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"delivery_lead_times\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"min_hours\": \"\",\n \"max_hours\": \"\",\n \"min_days\": \"\",\n \"max_days\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bde5fe53-6ad4-4607-aca5-0484b42b8e2d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9463a450-53dd-436e-9918-51c75c0a8dae" } ], "id": "eae1e792-72f6-4a22-a575-6caf8ebc7923", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-eae1e792-72f6-4a22-a575-6caf8ebc7923" }, { "name": "discount_engine_items", "item": [ { "name": "{discountEngineItemId}", "item": [ { "name": "discount_engine", "item": [ { "name": "Retrieve the discount engine associated to the discount engine item", "id": "65baf7e8-f02b-4cd0-98cd-2205bbb9bf97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId/discount_engine", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId", "discount_engine" ], "variable": [ { "id": "8e68e295-9377-4208-a959-482f52bd4d11", "key": "discountEngineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the discount engine associated to the discount engine item" }, "response": [ { "id": "41135bc2-5c3c-4999-9fc4-4067f9469b11", "name": "The discount_engine associated to the discount engine item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId/discount_engine", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId", "discount_engine" ], "variable": [ { "key": "discountEngineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-41135bc2-5c3c-4999-9fc4-4067f9469b11" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-65baf7e8-f02b-4cd0-98cd-2205bbb9bf97" } ], "id": "19286767-7a39-408a-a05c-3e035ca0d6b6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-19286767-7a39-408a-a05c-3e035ca0d6b6" }, { "name": "order", "item": [ { "name": "Retrieve the order associated to the discount engine item", "id": "8f900941-cc30-4e98-bf28-4e5be21d5bae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId/order", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId", "order" ], "variable": [ { "id": "f688adae-33b3-4d21-ad24-5dd0f0eedc6a", "key": "discountEngineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the discount engine item" }, "response": [ { "id": "ba1e1c3c-62cc-4d92-b4ef-e3a11eaf27c2", "name": "The order associated to the discount engine item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId/order", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId", "order" ], "variable": [ { "key": "discountEngineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ba1e1c3c-62cc-4d92-b4ef-e3a11eaf27c2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8f900941-cc30-4e98-bf28-4e5be21d5bae" } ], "id": "c1c5592b-cfad-45b6-a3af-fde458d49cf2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c1c5592b-cfad-45b6-a3af-fde458d49cf2" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the discount engine item", "id": "eec10556-d13c-433d-9f5e-082e33312509", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId", "event_stores" ], "variable": [ { "id": "8b842e44-d744-4ac1-a3c5-af1be961045e", "key": "discountEngineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the discount engine item" }, "response": [ { "id": "3e617378-722c-4b1a-8437-31a801db25b5", "name": "The event_stores associated to the discount engine item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId", "event_stores" ], "variable": [ { "key": "discountEngineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3e617378-722c-4b1a-8437-31a801db25b5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eec10556-d13c-433d-9f5e-082e33312509" } ], "id": "391a0843-83fc-459c-9d79-40271fa389f5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-391a0843-83fc-459c-9d79-40271fa389f5" }, { "name": "Retrieve a discount engine item", "id": "276a8170-a270-4851-88c3-68afd67c96a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId" ], "variable": [ { "id": "7f2298b7-bce4-42be-86a0-9f6d0173d259", "key": "discountEngineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a discount engine item" }, "response": [ { "id": "5db91981-1712-4a75-9ce9-62be6d322575", "name": "The discount engine item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engine_items/:discountEngineItemId", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items", ":discountEngineItemId" ], "variable": [ { "key": "discountEngineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"discount_engine_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5db91981-1712-4a75-9ce9-62be6d322575" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-276a8170-a270-4851-88c3-68afd67c96a0" } ], "id": "5c55773c-f3c7-4fe5-851b-e871afe57edc", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5c55773c-f3c7-4fe5-851b-e871afe57edc" }, { "name": "List all discount engine items", "id": "8474e169-24a6-4223-b557-5c769cca06c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/discount_engine_items", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items" ] }, "description": "List all discount engine items" }, "response": [ { "id": "2914a6ca-0add-4a50-b90d-fc24baf07502", "name": "A list of discount engine item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engine_items", "host": [ "{{baseUrl}}" ], "path": [ "discount_engine_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"discount_engine_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"discount_engine_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2914a6ca-0add-4a50-b90d-fc24baf07502" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8474e169-24a6-4223-b557-5c769cca06c3" } ], "id": "f56e6615-96d4-4abe-a0e1-57cdff39931d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f56e6615-96d4-4abe-a0e1-57cdff39931d" }, { "name": "discount_engines", "item": [ { "name": "{discountEngineId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the discount engine", "id": "280826a6-7b77-4169-90ed-fe7059dd9d4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/markets", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "markets" ], "variable": [ { "id": "b2907961-48e4-4add-b1bd-97688109b920", "key": "discountEngineId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the discount engine" }, "response": [ { "id": "2e2a1db6-306f-489a-b974-31a3c78a7d1a", "name": "The markets associated to the discount engine", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/markets", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "markets" ], "variable": [ { "key": "discountEngineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2e2a1db6-306f-489a-b974-31a3c78a7d1a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-280826a6-7b77-4169-90ed-fe7059dd9d4f" } ], "id": "0dc125ab-82d4-44be-9ea5-9b503917af1e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0dc125ab-82d4-44be-9ea5-9b503917af1e" }, { "name": "discount_engine_items", "item": [ { "name": "Retrieve the discount engine items associated to the discount engine", "id": "f1b727ca-c6c5-43da-9a31-770eca9bb35c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/discount_engine_items", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "discount_engine_items" ], "variable": [ { "id": "a1604deb-8c3f-4c4e-8ae9-f7921c8ea0a9", "key": "discountEngineId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the discount engine items associated to the discount engine" }, "response": [ { "id": "3306e720-fed4-4dff-b78c-640112357f7a", "name": "The discount_engine_items associated to the discount engine", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/discount_engine_items", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "discount_engine_items" ], "variable": [ { "key": "discountEngineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3306e720-fed4-4dff-b78c-640112357f7a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f1b727ca-c6c5-43da-9a31-770eca9bb35c" } ], "id": "c79317e7-ab95-498d-915f-d65ecfd63b4f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c79317e7-ab95-498d-915f-d65ecfd63b4f" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the discount engine", "id": "1e7c8dcb-0a55-4443-bacf-1faa523fdcc5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "attachments" ], "variable": [ { "id": "5475e8ca-2fd4-4db3-a905-2895c5b46345", "key": "discountEngineId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the discount engine" }, "response": [ { "id": "db2e4a45-dcc4-4c2d-9fb1-509bcd376114", "name": "The attachments associated to the discount engine", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "attachments" ], "variable": [ { "key": "discountEngineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-db2e4a45-dcc4-4c2d-9fb1-509bcd376114" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1e7c8dcb-0a55-4443-bacf-1faa523fdcc5" } ], "id": "68dcff63-c091-44ba-a212-a13b9f506646", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-68dcff63-c091-44ba-a212-a13b9f506646" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the discount engine", "id": "263674c9-18f9-40dc-a5ba-5bac8c0d63fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "event_stores" ], "variable": [ { "id": "674a94c6-62c7-4e40-a1a6-8fe4656b6528", "key": "discountEngineId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the discount engine" }, "response": [ { "id": "21209c14-9a81-4adb-9573-850fe933b05d", "name": "The event_stores associated to the discount engine", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId", "event_stores" ], "variable": [ { "key": "discountEngineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-21209c14-9a81-4adb-9573-850fe933b05d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-263674c9-18f9-40dc-a5ba-5bac8c0d63fd" } ], "id": "bb96d384-e605-491d-9514-bfa5bbdbe946", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bb96d384-e605-491d-9514-bfa5bbdbe946" }, { "name": "Retrieve a discount engine", "id": "f0c5d3d0-7bf0-4259-9d12-4bb19f24ed6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId" ], "variable": [ { "id": "b795b62e-d698-4617-b52a-67e0dd511026", "key": "discountEngineId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a discount engine" }, "response": [ { "id": "df8baebe-308e-42df-890c-bddcb61f4b4e", "name": "The discount engine object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engines/:discountEngineId", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines", ":discountEngineId" ], "variable": [ { "key": "discountEngineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"discount_engines\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df8baebe-308e-42df-890c-bddcb61f4b4e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f0c5d3d0-7bf0-4259-9d12-4bb19f24ed6c" } ], "id": "8c9dce36-d4f5-4d71-be9c-18607287eb05", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8c9dce36-d4f5-4d71-be9c-18607287eb05" }, { "name": "List all discount engines", "id": "93092994-1cfd-4b98-8b0c-878e64520ee5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/discount_engines", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines" ] }, "description": "List all discount engines" }, "response": [ { "id": "949f1c11-3bbb-488e-a780-ac48d3ceaa69", "name": "A list of discount engine objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/discount_engines", "host": [ "{{baseUrl}}" ], "path": [ "discount_engines" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"discount_engines\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"discount_engines\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-949f1c11-3bbb-488e-a780-ac48d3ceaa69" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-93092994-1cfd-4b98-8b0c-878e64520ee5" } ], "id": "8e963e15-87a7-4c12-90f6-409e903b7332", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8e963e15-87a7-4c12-90f6-409e903b7332" }, { "name": "easypost_pickups", "item": [ { "name": "{easypostPickupId}", "item": [ { "name": "shipment", "item": [ { "name": "Retrieve the shipment associated to the easypost pickup", "id": "848662c7-52fb-431c-9230-b3cc355a6284", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "shipment" ], "variable": [ { "id": "5408a930-4d68-43dc-a2db-7956d4465584", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipment associated to the easypost pickup" }, "response": [ { "id": "503b4124-e449-412a-8433-bad7c1d85e6b", "name": "The shipment associated to the easypost pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "shipment" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-503b4124-e449-412a-8433-bad7c1d85e6b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-848662c7-52fb-431c-9230-b3cc355a6284" } ], "id": "25b6f67e-a98c-4561-9525-b88fe408098a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-25b6f67e-a98c-4561-9525-b88fe408098a" }, { "name": "parcels", "item": [ { "name": "Retrieve the parcels associated to the easypost pickup", "id": "52e2ce37-b842-468a-a2ff-3c8e2c1e529b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "parcels" ], "variable": [ { "id": "a2c4842a-64b7-4a7b-8050-56f08696607a", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the parcels associated to the easypost pickup" }, "response": [ { "id": "839949cd-a1c5-4b3b-8c87-fc4f0ea5a579", "name": "The parcels associated to the easypost pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "parcels" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-839949cd-a1c5-4b3b-8c87-fc4f0ea5a579" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-52e2ce37-b842-468a-a2ff-3c8e2c1e529b" } ], "id": "23dfc1ec-eb74-4607-80bc-634792dd8340", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-23dfc1ec-eb74-4607-80bc-634792dd8340" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the easypost pickup", "id": "11ab77d5-cb63-4736-b15a-d2daa6096908", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/events", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "events" ], "variable": [ { "id": "4c777a09-8bb1-4c98-999b-d07b865c980f", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the easypost pickup" }, "response": [ { "id": "3d521021-0247-4fb6-b14d-db0fee148be3", "name": "The events associated to the easypost pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/events", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "events" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d521021-0247-4fb6-b14d-db0fee148be3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-11ab77d5-cb63-4736-b15a-d2daa6096908" } ], "id": "f3d12748-44bc-4af9-9741-8d4529479c5c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f3d12748-44bc-4af9-9741-8d4529479c5c" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the easypost pickup", "id": "5de98506-ffc3-42f8-844a-915622887675", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "event_stores" ], "variable": [ { "id": "74742b30-51f4-4227-b121-1d373b3b47d1", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the easypost pickup" }, "response": [ { "id": "fd37d599-1b10-4c74-a74b-72e9209e6f25", "name": "The event_stores associated to the easypost pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId", "event_stores" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fd37d599-1b10-4c74-a74b-72e9209e6f25" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5de98506-ffc3-42f8-844a-915622887675" } ], "id": "3e13c4e3-d9f3-4e28-a257-f4b60710290c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3e13c4e3-d9f3-4e28-a257-f4b60710290c" }, { "name": "Retrieve an easypost pickup", "id": "65702369-e0a8-4d3f-9327-0e0c4a4ed311", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId" ], "variable": [ { "id": "137c717e-2ad6-4bb2-903d-0f8cc661878d", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an easypost pickup" }, "response": [ { "id": "395880bb-ba0b-43f2-9b07-147c5be3cba8", "name": "The easypost pickup object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"easypost_pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"instructions\": \"\",\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-395880bb-ba0b-43f2-9b07-147c5be3cba8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-65702369-e0a8-4d3f-9327-0e0c4a4ed311" }, { "name": "Update an easypost pickup", "id": "e35b2465-44d4-49d2-b7f9-85dcbfa6672d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"easypost_pickups\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"_purchase\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId" ], "variable": [ { "id": "4d90a3a9-a03c-4cca-a984-8ff60b0ed916", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an easypost pickup" }, "response": [ { "id": "84b9b3ee-574e-441e-93b3-88faa13c7719", "name": "The updated easypost pickup object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"easypost_pickups\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"_purchase\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"easypost_pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"instructions\": \"\",\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-84b9b3ee-574e-441e-93b3-88faa13c7719" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e35b2465-44d4-49d2-b7f9-85dcbfa6672d" }, { "name": "Delete an easypost pickup", "id": "d73948a7-e960-4f37-bfbc-0fa7532a68ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId" ], "variable": [ { "id": "33707d42-0845-4de0-a64a-2f0b2250dea5", "key": "easypostPickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an easypost pickup" }, "response": [ { "id": "0cdec9b5-b12a-4cb2-b043-a2a9a76cbb5c", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups/:easypostPickupId", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups", ":easypostPickupId" ], "variable": [ { "key": "easypostPickupId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0cdec9b5-b12a-4cb2-b043-a2a9a76cbb5c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d73948a7-e960-4f37-bfbc-0fa7532a68ed" } ], "id": "8006b3f3-b8a1-4cea-84b4-c56476cfd527", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8006b3f3-b8a1-4cea-84b4-c56476cfd527" }, { "name": "List all easypost pickups", "id": "80436306-d534-4523-8996-28fcbeea50d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/easypost_pickups", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups" ] }, "description": "List all easypost pickups" }, "response": [ { "id": "2f2e3d84-35f9-4836-ae66-1e71362dda97", "name": "A list of easypost pickup objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/easypost_pickups", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"easypost_pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"instructions\": \"\",\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"easypost_pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"instructions\": \"\",\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2f2e3d84-35f9-4836-ae66-1e71362dda97" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-80436306-d534-4523-8996-28fcbeea50d4" }, { "name": "Create an easypost pickup", "id": "82224199-f84e-469a-9caa-b8ad376bd92e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"easypost_pickups\",\n \"attributes\": {\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"instructions\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/easypost_pickups", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups" ] }, "description": "Create an easypost pickup" }, "response": [ { "id": "3d100d97-8b62-46e3-aa80-6c0b2a930704", "name": "The created easypost pickup object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"easypost_pickups\",\n \"attributes\": {\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"instructions\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/easypost_pickups", "host": [ "{{baseUrl}}" ], "path": [ "easypost_pickups" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"easypost_pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"selected_rate_id\": \"\",\n \"instructions\": \"\",\n \"min_datetime\": \"\",\n \"max_datetime\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\"\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d100d97-8b62-46e3-aa80-6c0b2a930704" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-82224199-f84e-469a-9caa-b8ad376bd92e" } ], "id": "20be0983-6cff-4a47-a128-6fbbac306672", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-20be0983-6cff-4a47-a128-6fbbac306672" }, { "name": "event_callbacks", "item": [ { "name": "{eventCallbackId}", "item": [ { "name": "webhook", "item": [ { "name": "Retrieve the webhook associated to the event callback", "id": "d3e0a722-0ca7-442f-9b0f-21d1af95d2fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/event_callbacks/:eventCallbackId/webhook", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks", ":eventCallbackId", "webhook" ], "variable": [ { "id": "7023b012-099c-45d2-9279-d5d21e7c422c", "key": "eventCallbackId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the webhook associated to the event callback" }, "response": [ { "id": "52c9babf-2b89-4e02-990a-906e440bda83", "name": "The webhook associated to the event callback", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/event_callbacks/:eventCallbackId/webhook", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks", ":eventCallbackId", "webhook" ], "variable": [ { "key": "eventCallbackId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-52c9babf-2b89-4e02-990a-906e440bda83" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d3e0a722-0ca7-442f-9b0f-21d1af95d2fd" } ], "id": "56361b1c-639d-4c6b-92bb-dc6ced15ae0e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-56361b1c-639d-4c6b-92bb-dc6ced15ae0e" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the event callback", "id": "5842678e-fabc-44ef-a653-811cb027a934", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/event_callbacks/:eventCallbackId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks", ":eventCallbackId", "event_stores" ], "variable": [ { "id": "1684185e-c2df-46fe-aa83-2339822eb8a6", "key": "eventCallbackId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the event callback" }, "response": [ { "id": "cc245496-fa24-45cd-a53c-a6dc3dfbd9d5", "name": "The event_stores associated to the event callback", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/event_callbacks/:eventCallbackId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks", ":eventCallbackId", "event_stores" ], "variable": [ { "key": "eventCallbackId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cc245496-fa24-45cd-a53c-a6dc3dfbd9d5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5842678e-fabc-44ef-a653-811cb027a934" } ], "id": "c6f48b48-0e6a-4c13-b206-f740acbd536c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c6f48b48-0e6a-4c13-b206-f740acbd536c" }, { "name": "Retrieve an event callback", "id": "aeee9d76-f79b-4f9b-8228-c0101a7ac5a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/event_callbacks/:eventCallbackId", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks", ":eventCallbackId" ], "variable": [ { "id": "68863e0b-f270-47d9-9821-93999757a966", "key": "eventCallbackId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an event callback" }, "response": [ { "id": "18a3380f-0c7c-4e7e-b637-2612890897ec", "name": "The event callback object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/event_callbacks/:eventCallbackId", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks", ":eventCallbackId" ], "variable": [ { "key": "eventCallbackId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"event_callbacks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"callback_url\": \"\",\n \"payload\": {},\n \"response_code\": \"\",\n \"response_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhook\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhook\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-18a3380f-0c7c-4e7e-b637-2612890897ec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-aeee9d76-f79b-4f9b-8228-c0101a7ac5a8" } ], "id": "8f28fe8c-3ed5-4f21-9059-509c8e5b8075", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8f28fe8c-3ed5-4f21-9059-509c8e5b8075" }, { "name": "List all event callbacks", "id": "77168e87-ff35-4df6-bfef-d9da537ae8db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/event_callbacks", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks" ] }, "description": "List all event callbacks" }, "response": [ { "id": "9dba2456-b1d4-4678-8616-3776eadc8aa8", "name": "A list of event callback objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/event_callbacks", "host": [ "{{baseUrl}}" ], "path": [ "event_callbacks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"event_callbacks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"callback_url\": \"\",\n \"payload\": {},\n \"response_code\": \"\",\n \"response_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhook\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhook\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"event_callbacks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"callback_url\": \"\",\n \"payload\": {},\n \"response_code\": \"\",\n \"response_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhook\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhook\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9dba2456-b1d4-4678-8616-3776eadc8aa8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-77168e87-ff35-4df6-bfef-d9da537ae8db" } ], "id": "9e288e57-89fc-4ae8-a705-cdf30fbd6e59", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9e288e57-89fc-4ae8-a705-cdf30fbd6e59" }, { "name": "event_stores", "item": [ { "name": "{eventStoreId}", "item": [ { "name": "Retrieve an event store", "id": "d4cd7a85-85bf-43ce-9415-b18a0c036fe4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/event_stores/:eventStoreId", "host": [ "{{baseUrl}}" ], "path": [ "event_stores", ":eventStoreId" ], "variable": [ { "id": "fbc2d6f0-947d-46fe-8bf5-804bafabc513", "key": "eventStoreId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an event store" }, "response": [ { "id": "bac8cc10-ac85-45b1-bb3e-3787fd9ba572", "name": "The event store object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/event_stores/:eventStoreId", "host": [ "{{baseUrl}}" ], "path": [ "event_stores", ":eventStoreId" ], "variable": [ { "key": "eventStoreId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"event_stores\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"event\": \"\",\n \"payload\": {},\n \"who\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bac8cc10-ac85-45b1-bb3e-3787fd9ba572" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d4cd7a85-85bf-43ce-9415-b18a0c036fe4" } ], "id": "6dadb67b-5a8f-43f4-a824-3f3a2a2dd72f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6dadb67b-5a8f-43f4-a824-3f3a2a2dd72f" } ], "id": "f9b838ed-9389-4f0d-92a9-a6ae0ed072a2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f9b838ed-9389-4f0d-92a9-a6ae0ed072a2" }, { "name": "events", "item": [ { "name": "{eventId}", "item": [ { "name": "webhooks", "item": [ { "name": "Retrieve the webhooks associated to the event", "id": "da7a0593-a290-4e97-89a0-e40167eaf286", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/events/:eventId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId", "webhooks" ], "variable": [ { "id": "191be882-4264-4cae-a2c9-406461d66ce7", "key": "eventId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the webhooks associated to the event" }, "response": [ { "id": "2e27d32d-a020-493b-b63b-fb8840171794", "name": "The webhooks associated to the event", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/events/:eventId/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId", "webhooks" ], "variable": [ { "key": "eventId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2e27d32d-a020-493b-b63b-fb8840171794" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-da7a0593-a290-4e97-89a0-e40167eaf286" } ], "id": "5d11b942-a7d0-4051-b386-ebfdc86d33a5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5d11b942-a7d0-4051-b386-ebfdc86d33a5" }, { "name": "last_event_callbacks", "item": [ { "name": "Retrieve the last event callbacks associated to the event", "id": "60e24dbe-efa9-4fa6-9a2c-264f840fdb99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/events/:eventId/last_event_callbacks", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId", "last_event_callbacks" ], "variable": [ { "id": "28a017a9-435c-4d31-85f0-3c3c583b3db7", "key": "eventId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the last event callbacks associated to the event" }, "response": [ { "id": "6f7fd889-b9b6-461c-86d7-60a003ddfaf1", "name": "The last_event_callbacks associated to the event", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/events/:eventId/last_event_callbacks", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId", "last_event_callbacks" ], "variable": [ { "key": "eventId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6f7fd889-b9b6-461c-86d7-60a003ddfaf1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-60e24dbe-efa9-4fa6-9a2c-264f840fdb99" } ], "id": "28b837ad-1fe7-4558-94c4-92c35a6f3a83", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-28b837ad-1fe7-4558-94c4-92c35a6f3a83" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the event", "id": "98e4e1ed-d923-49c5-8df6-bf521d38de42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/events/:eventId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId", "event_stores" ], "variable": [ { "id": "d39d8d67-2ce1-4660-84a2-d5b6217f2b46", "key": "eventId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the event" }, "response": [ { "id": "e9eb713e-caec-48f7-b8d9-ecdb5905deb2", "name": "The event_stores associated to the event", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/events/:eventId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId", "event_stores" ], "variable": [ { "key": "eventId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e9eb713e-caec-48f7-b8d9-ecdb5905deb2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98e4e1ed-d923-49c5-8df6-bf521d38de42" } ], "id": "37d08267-286f-4cd5-8f07-a4e9844ff7ef", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-37d08267-286f-4cd5-8f07-a4e9844ff7ef" }, { "name": "Retrieve an event", "id": "9f697642-4c92-484a-ae74-cbb0c7397ef2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId" ], "variable": [ { "id": "077ea06e-7928-45ee-ba33-5400bda9fe36", "key": "eventId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an event" }, "response": [ { "id": "82d277aa-762d-4a4a-9724-0d92fd7638ea", "name": "The event object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId" ], "variable": [ { "key": "eventId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"events\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhooks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhooks\",\n \"id\": \"\"\n }\n },\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-82d277aa-762d-4a4a-9724-0d92fd7638ea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9f697642-4c92-484a-ae74-cbb0c7397ef2" }, { "name": "Update an event", "id": "52b145b9-bcab-4e91-8590-06549fbf9209", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\",\n \"attributes\": {\n \"_trigger\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId" ], "variable": [ { "id": "1f2ef494-2964-4888-953e-66242cbb34d9", "key": "eventId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an event" }, "response": [ { "id": "75649e9d-2f09-4868-840c-3844c9dcb12d", "name": "The updated event object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\",\n \"attributes\": {\n \"_trigger\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/events/:eventId", "host": [ "{{baseUrl}}" ], "path": [ "events", ":eventId" ], "variable": [ { "key": "eventId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"events\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhooks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhooks\",\n \"id\": \"\"\n }\n },\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-75649e9d-2f09-4868-840c-3844c9dcb12d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-52b145b9-bcab-4e91-8590-06549fbf9209" } ], "id": "e7469763-ef76-4b2e-9627-1bd878a9f362", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e7469763-ef76-4b2e-9627-1bd878a9f362" }, { "name": "List all events", "id": "5a11f590-4abc-4305-bcfa-9251c9674aef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ] }, "description": "List all events" }, "response": [ { "id": "786fd384-9f8b-4de1-899e-5c0860fa3f47", "name": "A list of event objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/events", "host": [ "{{baseUrl}}" ], "path": [ "events" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"events\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhooks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhooks\",\n \"id\": \"\"\n }\n },\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"events\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"webhooks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"webhooks\",\n \"id\": \"\"\n }\n },\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-786fd384-9f8b-4de1-899e-5c0860fa3f47" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5a11f590-4abc-4305-bcfa-9251c9674aef" } ], "id": "9c12c637-eb89-4773-aaeb-615bb3cfe4b7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9c12c637-eb89-4773-aaeb-615bb3cfe4b7" }, { "name": "exports", "item": [ { "name": "{exportId}", "item": [ { "name": "events", "item": [ { "name": "Retrieve the events associated to the export", "id": "967fdb75-61a2-4a27-b88f-9de5305f1d6b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/exports/:exportId/events", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId", "events" ], "variable": [ { "id": "90f970a8-17cf-4038-8b6b-4090f328984b", "key": "exportId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the export" }, "response": [ { "id": "3d2b50cb-525a-4985-9451-024b2857aab9", "name": "The events associated to the export", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/exports/:exportId/events", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId", "events" ], "variable": [ { "key": "exportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d2b50cb-525a-4985-9451-024b2857aab9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-967fdb75-61a2-4a27-b88f-9de5305f1d6b" } ], "id": "5e7321f1-10d5-49e4-ba5a-424bcadcb575", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5e7321f1-10d5-49e4-ba5a-424bcadcb575" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the export", "id": "d53271d1-e3fd-4c1d-ae15-d15eae0ca813", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/exports/:exportId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId", "event_stores" ], "variable": [ { "id": "b5b404b5-9828-4b85-80b6-2a16ad1b9361", "key": "exportId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the export" }, "response": [ { "id": "9bf103c9-c0f2-4c3e-b49d-3a29e8fc0c21", "name": "The event_stores associated to the export", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/exports/:exportId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId", "event_stores" ], "variable": [ { "key": "exportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9bf103c9-c0f2-4c3e-b49d-3a29e8fc0c21" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d53271d1-e3fd-4c1d-ae15-d15eae0ca813" } ], "id": "91f65bd1-f9ec-4c48-860d-f4f542b73adc", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-91f65bd1-f9ec-4c48-860d-f4f542b73adc" }, { "name": "Retrieve an export", "id": "276f816e-3e12-443a-a733-908643c8af4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "id": "c62ac36b-4aa7-46b8-ab59-1d46552d5ab2", "key": "exportId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an export" }, "response": [ { "id": "fe42ee29-9acb-43f5-a87d-350510568056", "name": "The export object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "key": "exportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"exports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"status\": \"in_progress\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"estimated_completion_at\": \"\",\n \"interrupted_at\": \"\",\n \"records_count\": \"\",\n \"processed_count\": \"\",\n \"progress\": \"\",\n \"attachment_url\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fe42ee29-9acb-43f5-a87d-350510568056" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-276f816e-3e12-443a-a733-908643c8af4d" }, { "name": "Update an export", "id": "0a2f1b16-78c4-4e3b-acd6-37f21975e9bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"exports\",\n \"id\": \"\",\n \"attributes\": {\n \"_start\": \"\",\n \"_interrupt\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "id": "6efa9098-292d-43ab-97d2-f8a0f5ffaf6f", "key": "exportId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an export" }, "response": [ { "id": "91d5bdfb-2198-4610-b054-f159ba811cb2", "name": "The updated export object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"exports\",\n \"id\": \"\",\n \"attributes\": {\n \"_start\": \"\",\n \"_interrupt\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "key": "exportId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"exports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"status\": \"in_progress\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"estimated_completion_at\": \"\",\n \"interrupted_at\": \"\",\n \"records_count\": \"\",\n \"processed_count\": \"\",\n \"progress\": \"\",\n \"attachment_url\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-91d5bdfb-2198-4610-b054-f159ba811cb2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0a2f1b16-78c4-4e3b-acd6-37f21975e9bd" }, { "name": "Delete an export", "id": "ac154ab5-8cdc-4837-a252-7e7b95d956e2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "id": "a0d91fef-d18f-4cc5-913b-4e4cf5dea87f", "key": "exportId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an export" }, "response": [ { "id": "8c0ead7c-966c-4cd9-860c-1aecd47c22e4", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/exports/:exportId", "host": [ "{{baseUrl}}" ], "path": [ "exports", ":exportId" ], "variable": [ { "key": "exportId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8c0ead7c-966c-4cd9-860c-1aecd47c22e4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ac154ab5-8cdc-4837-a252-7e7b95d956e2" } ], "id": "fafb09a9-2192-4976-b302-11dbeacdd74a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fafb09a9-2192-4976-b302-11dbeacdd74a" }, { "name": "List all exports", "id": "81182761-951a-41a9-abc6-1c54b046ee89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ] }, "description": "List all exports" }, "response": [ { "id": "01ea159f-9ead-40f1-a9da-a97245214f76", "name": "A list of export objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"exports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"status\": \"pending\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"estimated_completion_at\": \"\",\n \"interrupted_at\": \"\",\n \"records_count\": \"\",\n \"processed_count\": \"\",\n \"progress\": \"\",\n \"attachment_url\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"exports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"status\": \"interrupted\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"estimated_completion_at\": \"\",\n \"interrupted_at\": \"\",\n \"records_count\": \"\",\n \"processed_count\": \"\",\n \"progress\": \"\",\n \"attachment_url\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-01ea159f-9ead-40f1-a9da-a97245214f76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-81182761-951a-41a9-abc6-1c54b046ee89" }, { "name": "Create an export", "id": "3d5f3f85-146c-4862-8a79-2c6a231e63e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"exports\",\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ] }, "description": "Create an export" }, "response": [ { "id": "6760e0bb-abdc-467c-b978-a12e5b53d649", "name": "The created export object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"exports\",\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/exports", "host": [ "{{baseUrl}}" ], "path": [ "exports" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"exports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"status\": \"in_progress\",\n \"includes\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n \"\",\n \"\"\n ],\n \"filters\": {},\n \"dry_data\": \"\",\n \"jwt_filters\": \"\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"estimated_completion_at\": \"\",\n \"interrupted_at\": \"\",\n \"records_count\": \"\",\n \"processed_count\": \"\",\n \"progress\": \"\",\n \"attachment_url\": \"\",\n \"errors_log\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6760e0bb-abdc-467c-b978-a12e5b53d649" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3d5f3f85-146c-4862-8a79-2c6a231e63e3" } ], "id": "2a753be6-580e-44cc-8271-b51619c4c90d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2a753be6-580e-44cc-8271-b51619c4c90d" }, { "name": "external_gateways", "item": [ { "name": "{externalGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the external gateway", "id": "5353f7b7-4427-4aad-94ff-26e8922e5980", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId", "payment_methods" ], "variable": [ { "id": "7262ae3e-2798-4f08-97e4-02354588bc38", "key": "externalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the external gateway" }, "response": [ { "id": "0921659e-eee5-4fe9-89a6-3d76d585ac12", "name": "The payment_methods associated to the external gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId", "payment_methods" ], "variable": [ { "key": "externalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0921659e-eee5-4fe9-89a6-3d76d585ac12" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5353f7b7-4427-4aad-94ff-26e8922e5980" } ], "id": "d524bf6b-3147-4006-9425-96ca333cc1b3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d524bf6b-3147-4006-9425-96ca333cc1b3" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the external gateway", "id": "39b68bfa-d14e-4bbe-925b-447a774485de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId", "event_stores" ], "variable": [ { "id": "923ce5b5-c50f-42a7-b194-e4298cb60250", "key": "externalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the external gateway" }, "response": [ { "id": "3f9888bd-b632-422f-8efb-c3249d1e2cca", "name": "The event_stores associated to the external gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId", "event_stores" ], "variable": [ { "key": "externalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3f9888bd-b632-422f-8efb-c3249d1e2cca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-39b68bfa-d14e-4bbe-925b-447a774485de" } ], "id": "61407e9c-d962-488f-ae7d-b5ecee1a9586", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-61407e9c-d962-488f-ae7d-b5ecee1a9586" }, { "name": "external_payments", "item": [ { "name": "Retrieve the external payments associated to the external gateway", "id": "0f6ebf6c-8ac8-4935-a3e4-6d0103c70497", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId/external_payments", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId", "external_payments" ], "variable": [ { "id": "3c197d7d-7471-4d03-9306-3b590136d21c", "key": "externalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the external payments associated to the external gateway" }, "response": [ { "id": "dfa233ae-52c4-4d16-820f-b2c38ce6837c", "name": "The external_payments associated to the external gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId/external_payments", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId", "external_payments" ], "variable": [ { "key": "externalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dfa233ae-52c4-4d16-820f-b2c38ce6837c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0f6ebf6c-8ac8-4935-a3e4-6d0103c70497" } ], "id": "4ae170cc-170b-4d27-b34e-ca383112b87d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4ae170cc-170b-4d27-b34e-ca383112b87d" }, { "name": "Retrieve an external gateway", "id": "a90a489e-fc02-4299-bdcb-143540d89212", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId" ], "variable": [ { "id": "e4ffdcde-ac9b-48ac-a812-b4de3e053bc8", "key": "externalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an external gateway" }, "response": [ { "id": "000419b9-dce6-46a8-904f-e2757caf1f16", "name": "The external gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId" ], "variable": [ { "key": "externalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"external_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-000419b9-dce6-46a8-904f-e2757caf1f16" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a90a489e-fc02-4299-bdcb-143540d89212" }, { "name": "Update an external gateway", "id": "b7cc4e0c-0a7c-4f2a-9ce7-7c5830c4e039", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId" ], "variable": [ { "id": "c3fe7fc5-c692-4b8e-a6df-93c8637a755b", "key": "externalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an external gateway" }, "response": [ { "id": "d8b3d324-0e48-48b1-a729-90955a1e88f3", "name": "The updated external gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId" ], "variable": [ { "key": "externalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"external_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d8b3d324-0e48-48b1-a729-90955a1e88f3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b7cc4e0c-0a7c-4f2a-9ce7-7c5830c4e039" }, { "name": "Delete an external gateway", "id": "f8d89da6-53b2-4710-8b64-50ca3d3b9772", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId" ], "variable": [ { "id": "e5fcdf2c-e492-4525-a29e-34cfe4a88374", "key": "externalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an external gateway" }, "response": [ { "id": "f7a0da95-3880-41ec-86d0-d8c3c83ac42d", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_gateways/:externalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways", ":externalGatewayId" ], "variable": [ { "key": "externalGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f7a0da95-3880-41ec-86d0-d8c3c83ac42d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f8d89da6-53b2-4710-8b64-50ca3d3b9772" } ], "id": "d13ae4f4-c09f-43f8-a20f-7f6ef9dade8d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d13ae4f4-c09f-43f8-a20f-7f6ef9dade8d" }, { "name": "List all external gateways", "id": "d6954a0a-b9ee-4b3f-9666-5285f87841f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_gateways", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways" ] }, "description": "List all external gateways" }, "response": [ { "id": "8eeae923-7895-4532-8aa1-ed1e5fb7483a", "name": "A list of external gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_gateways", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"external_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"external_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"external_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"external_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8eeae923-7895-4532-8aa1-ed1e5fb7483a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d6954a0a-b9ee-4b3f-9666-5285f87841f4" }, { "name": "Create an external gateway", "id": "ba45c6df-65e2-467d-9d06-26a8b57aa367", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_gateways", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways" ] }, "description": "Create an external gateway" }, "response": [ { "id": "2f6032e5-a83d-48b3-a946-7a884f120554", "name": "The created external gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_gateways", "host": [ "{{baseUrl}}" ], "path": [ "external_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"authorize_url\": \"\",\n \"capture_url\": \"\",\n \"void_url\": \"\",\n \"refund_url\": \"\",\n \"token_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"external_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2f6032e5-a83d-48b3-a946-7a884f120554" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba45c6df-65e2-467d-9d06-26a8b57aa367" } ], "id": "2ac23c71-b996-48cf-ac94-67781484deea", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2ac23c71-b996-48cf-ac94-67781484deea" }, { "name": "external_payments", "item": [ { "name": "{externalPaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the external payment", "id": "330276a7-ea5e-41f5-87f5-16c194df499a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "order" ], "variable": [ { "id": "7a70613d-4d78-4c64-b84e-96e8cc0190e4", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the external payment" }, "response": [ { "id": "7ed9f6af-94c2-4f52-a214-6a07f518b263", "name": "The order associated to the external payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "order" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7ed9f6af-94c2-4f52-a214-6a07f518b263" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-330276a7-ea5e-41f5-87f5-16c194df499a" } ], "id": "3190e336-9264-451d-8172-54c1f2abcfb6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3190e336-9264-451d-8172-54c1f2abcfb6" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the external payment", "id": "186a66e8-f9d4-4c5d-8d44-d57e0965af7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "payment_gateway" ], "variable": [ { "id": "fad38f6d-dfc9-4ff4-886f-015615e1c6f1", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the external payment" }, "response": [ { "id": "16db38a1-6a25-434d-927d-7d0e82fcb284", "name": "The payment_gateway associated to the external payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "payment_gateway" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-16db38a1-6a25-434d-927d-7d0e82fcb284" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-186a66e8-f9d4-4c5d-8d44-d57e0965af7c" } ], "id": "80757759-f7cb-489e-8d77-bcc56e9b74cf", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-80757759-f7cb-489e-8d77-bcc56e9b74cf" }, { "name": "wallet", "item": [ { "name": "Retrieve the wallet associated to the external payment", "id": "6f084606-a08c-404f-aab3-60850e76bec2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/wallet", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "wallet" ], "variable": [ { "id": "dfba7937-0d44-49b0-bad7-05a44bae98c6", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the wallet associated to the external payment" }, "response": [ { "id": "981424d5-1476-4862-be33-b7b5a6e79509", "name": "The wallet associated to the external payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/wallet", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "wallet" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-981424d5-1476-4862-be33-b7b5a6e79509" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f084606-a08c-404f-aab3-60850e76bec2" } ], "id": "7281bad0-f1be-4a3d-8872-2e3b4b64c4b7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7281bad0-f1be-4a3d-8872-2e3b4b64c4b7" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the external payment", "id": "07325a74-98db-4dd7-a0d2-2da17af4eef1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "event_stores" ], "variable": [ { "id": "4eecead0-a017-40e4-bebb-68df8beda8a9", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the external payment" }, "response": [ { "id": "c5c815aa-90dd-490e-a65a-621639865b2a", "name": "The event_stores associated to the external payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId", "event_stores" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c5c815aa-90dd-490e-a65a-621639865b2a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07325a74-98db-4dd7-a0d2-2da17af4eef1" } ], "id": "388a0482-ffd8-47d8-8c5f-2c4c96f1fce6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-388a0482-ffd8-47d8-8c5f-2c4c96f1fce6" }, { "name": "Retrieve an external payment", "id": "f5a7f4cb-4392-4de8-8862-9edfcd60a4b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId" ], "variable": [ { "id": "970352cc-c593-4c01-8c3e-303f8b78dd3d", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an external payment" }, "response": [ { "id": "e3075a52-dabf-4d67-8d1a-a042046addc2", "name": "The external payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"wallet\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"wallet\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3075a52-dabf-4d67-8d1a-a042046addc2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f5a7f4cb-4392-4de8-8862-9edfcd60a4b1" }, { "name": "Update an external payment", "id": "6903079a-0291-41a5-b405-2528ec9e50c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId" ], "variable": [ { "id": "a2967573-3647-4bc3-b9de-086d59d5ee3d", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an external payment" }, "response": [ { "id": "1931ecdc-5fd8-4ec2-8abe-55d5aacb34d3", "name": "The updated external payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"wallet\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"wallet\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1931ecdc-5fd8-4ec2-8abe-55d5aacb34d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6903079a-0291-41a5-b405-2528ec9e50c4" }, { "name": "Delete an external payment", "id": "8df13a88-e8a4-4534-bd27-779528bcd44a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId" ], "variable": [ { "id": "8d50944f-a78f-4e9d-a44d-b0ec04aa7add", "key": "externalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an external payment" }, "response": [ { "id": "4ceeccae-06e0-4448-8878-d998e6916ee5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments/:externalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "external_payments", ":externalPaymentId" ], "variable": [ { "key": "externalPaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4ceeccae-06e0-4448-8878-d998e6916ee5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8df13a88-e8a4-4534-bd27-779528bcd44a" } ], "id": "37640ec0-22af-4db1-b6b5-1b2bf6da4dad", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-37640ec0-22af-4db1-b6b5-1b2bf6da4dad" }, { "name": "List all external payments", "id": "fec349ad-6786-4c33-a41b-31bb72ef1def", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_payments", "host": [ "{{baseUrl}}" ], "path": [ "external_payments" ] }, "description": "List all external payments" }, "response": [ { "id": "e04ecf66-d490-4e6b-a3d6-bb815832261f", "name": "A list of external payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_payments", "host": [ "{{baseUrl}}" ], "path": [ "external_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"external_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"wallet\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"wallet\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"external_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"wallet\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"wallet\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e04ecf66-d490-4e6b-a3d6-bb815832261f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fec349ad-6786-4c33-a41b-31bb72ef1def" }, { "name": "Create an external payment", "id": "425bd604-b8b0-4bdb-b9be-590b80a28b65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_payments\",\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_payments", "host": [ "{{baseUrl}}" ], "path": [ "external_payments" ] }, "description": "Create an external payment" }, "response": [ { "id": "aacf7220-7af2-43e1-9358-e00f97ac6c55", "name": "The created external payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_payments\",\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_payments", "host": [ "{{baseUrl}}" ], "path": [ "external_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_source_token\": \"\",\n \"options\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"wallet\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"wallet\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aacf7220-7af2-43e1-9358-e00f97ac6c55" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-425bd604-b8b0-4bdb-b9be-590b80a28b65" } ], "id": "4dc20826-2171-4dcf-ae8b-646dd42c5b99", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4dc20826-2171-4dcf-ae8b-646dd42c5b99" }, { "name": "external_promotions", "item": [ { "name": "{externalPromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the external promotion", "id": "460bd077-d2a6-4a69-9dbf-c6d7bce6bc74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "market" ], "variable": [ { "id": "9ca16d45-3f20-4002-b035-a3a078d3d619", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the external promotion" }, "response": [ { "id": "0630d533-d551-4ef2-8f4d-a093c3e31c6d", "name": "The market associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "market" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0630d533-d551-4ef2-8f4d-a093c3e31c6d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-460bd077-d2a6-4a69-9dbf-c6d7bce6bc74" } ], "id": "12b53121-7238-4e7a-84a9-8730b7216c76", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-12b53121-7238-4e7a-84a9-8730b7216c76" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the external promotion", "id": "28ffb9d0-49d5-44eb-a175-5a5c10e0825a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "c4538481-3f46-497a-ad2d-8cfc57f59c0c", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the external promotion" }, "response": [ { "id": "44594fe2-6a68-410b-9697-e5b36a5c11f0", "name": "The order_amount_promotion_rule associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-44594fe2-6a68-410b-9697-e5b36a5c11f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-28ffb9d0-49d5-44eb-a175-5a5c10e0825a" } ], "id": "57a3a8a1-ac9d-45c1-8526-2bdae2cd3151", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-57a3a8a1-ac9d-45c1-8526-2bdae2cd3151" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the external promotion", "id": "d687e493-aa65-43c5-8714-5379f3eb8f0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "c955b6de-fae9-4dff-a7ff-90a7e64e2648", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the external promotion" }, "response": [ { "id": "cd23460c-83b9-42fa-ba77-4c8850886359", "name": "The sku_list_promotion_rule associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd23460c-83b9-42fa-ba77-4c8850886359" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d687e493-aa65-43c5-8714-5379f3eb8f0d" } ], "id": "dfb13d3b-eeb0-4bf9-8cda-f51aef669558", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dfb13d3b-eeb0-4bf9-8cda-f51aef669558" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the external promotion", "id": "49fb4812-0ca5-4a72-81b3-499245be6e5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "ac66cb29-1e73-4bbd-bf46-0699916b8487", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the external promotion" }, "response": [ { "id": "872ac783-5bda-4d3c-8d79-2fbbfc77c055", "name": "The coupon_codes_promotion_rule associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-872ac783-5bda-4d3c-8d79-2fbbfc77c055" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-49fb4812-0ca5-4a72-81b3-499245be6e5d" } ], "id": "c3941b6a-8b18-4add-81c2-c095ca3117f3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c3941b6a-8b18-4add-81c2-c095ca3117f3" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the external promotion", "id": "3f8a82b9-ac1a-4362-a619-041a823df88a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "custom_promotion_rule" ], "variable": [ { "id": "01d8e3f5-768e-4cec-9c71-2a96d66d3759", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the external promotion" }, "response": [ { "id": "455b2b50-8d18-4c6f-ae49-505b8b7dfcd2", "name": "The custom_promotion_rule associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "custom_promotion_rule" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-455b2b50-8d18-4c6f-ae49-505b8b7dfcd2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3f8a82b9-ac1a-4362-a619-041a823df88a" } ], "id": "8a041bf0-a7ec-4eb3-841a-2e915bc3eb07", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8a041bf0-a7ec-4eb3-841a-2e915bc3eb07" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the external promotion", "id": "d571ec2a-ed98-4999-beea-f6b500aa8e8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "sku_list" ], "variable": [ { "id": "e3333417-9b7c-4020-b02f-50c66e54e780", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the external promotion" }, "response": [ { "id": "a07b3fb5-3f7b-451c-9ec7-9a05d592853d", "name": "The sku_list associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "sku_list" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a07b3fb5-3f7b-451c-9ec7-9a05d592853d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d571ec2a-ed98-4999-beea-f6b500aa8e8c" } ], "id": "291d7dec-0388-442f-9608-86410b98fd6d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-291d7dec-0388-442f-9608-86410b98fd6d" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the external promotion", "id": "1dd49b92-b63e-4116-a89b-bd059f06094e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "coupons" ], "variable": [ { "id": "662e943b-aba3-4a81-a7bc-5af0c8bee74a", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the external promotion" }, "response": [ { "id": "53d589ca-4827-4677-b9e5-c61ed1398e76", "name": "The coupons associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "coupons" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-53d589ca-4827-4677-b9e5-c61ed1398e76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1dd49b92-b63e-4116-a89b-bd059f06094e" } ], "id": "2c330bd0-7928-4a1d-bd83-db4199aa01d0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2c330bd0-7928-4a1d-bd83-db4199aa01d0" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the external promotion", "id": "2d122ec6-b1fd-4f0c-b2a7-81c9b09a9d3a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "attachments" ], "variable": [ { "id": "9233ff19-1066-47a9-9f31-dce7bf464912", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the external promotion" }, "response": [ { "id": "eaee1c59-8338-435a-b1bd-3802caada181", "name": "The attachments associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "attachments" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-eaee1c59-8338-435a-b1bd-3802caada181" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d122ec6-b1fd-4f0c-b2a7-81c9b09a9d3a" } ], "id": "05559700-df84-411d-9583-eba4c00e1906", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-05559700-df84-411d-9583-eba4c00e1906" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the external promotion", "id": "230933c8-2945-42e2-9a9d-87c7aff07b88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "events" ], "variable": [ { "id": "be4f1b6a-4c6b-409b-88fc-5bf7a9c7384b", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the external promotion" }, "response": [ { "id": "3f7fb2bf-bcf7-430a-ab03-674620f95607", "name": "The events associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "events" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3f7fb2bf-bcf7-430a-ab03-674620f95607" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-230933c8-2945-42e2-9a9d-87c7aff07b88" } ], "id": "cef0af86-5cf0-4b04-9a75-646da2a8e9ac", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cef0af86-5cf0-4b04-9a75-646da2a8e9ac" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the external promotion", "id": "f1d9d436-d2a0-49ce-b004-b7398fa1e77d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "tags" ], "variable": [ { "id": "11539f2e-a38f-4b07-b7d1-fbe33204f106", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the external promotion" }, "response": [ { "id": "f98bd315-2705-415d-80a6-cb6c153201dd", "name": "The tags associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "tags" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f98bd315-2705-415d-80a6-cb6c153201dd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f1d9d436-d2a0-49ce-b004-b7398fa1e77d" } ], "id": "48db8a18-b1d9-40a6-a569-f9e21051def1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-48db8a18-b1d9-40a6-a569-f9e21051def1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the external promotion", "id": "886d621c-c3cc-470f-8a99-7cb329033090", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "event_stores" ], "variable": [ { "id": "c0106d45-a1fe-4660-a40f-57f321db145c", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the external promotion" }, "response": [ { "id": "bb7d14d2-eb3e-4e05-8799-71dc780b50a1", "name": "The event_stores associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "event_stores" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bb7d14d2-eb3e-4e05-8799-71dc780b50a1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-886d621c-c3cc-470f-8a99-7cb329033090" } ], "id": "ba01a7fd-9055-4640-9c5f-c83b852cc04b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ba01a7fd-9055-4640-9c5f-c83b852cc04b" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the external promotion", "id": "2d144136-82af-4d55-9517-823f520b039d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "skus" ], "variable": [ { "id": "c6ad25ff-1ebd-4a1a-bf67-e690c485b96f", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the external promotion" }, "response": [ { "id": "6c576f59-e1eb-40ce-80c8-5d7391042535", "name": "The skus associated to the external promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId", "skus" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6c576f59-e1eb-40ce-80c8-5d7391042535" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d144136-82af-4d55-9517-823f520b039d" } ], "id": "67211e5d-156d-4e50-9826-d75644f0044d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-67211e5d-156d-4e50-9826-d75644f0044d" }, { "name": "Retrieve an external promotion", "id": "ba088d8a-6279-4aac-965c-c85275098e92", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId" ], "variable": [ { "id": "690f8383-5c65-4045-9dd5-2dc0140dd32a", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an external promotion" }, "response": [ { "id": "43e9dddb-361a-414c-af51-73b560357492", "name": "The external promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-43e9dddb-361a-414c-af51-73b560357492" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba088d8a-6279-4aac-965c-c85275098e92" }, { "name": "Update an external promotion", "id": "c0647236-73b9-4343-ab23-505f84403ff3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId" ], "variable": [ { "id": "8b6a0d8f-02b8-4b02-b1e4-78e719172dbb", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an external promotion" }, "response": [ { "id": "d506842f-7a54-4f4f-a339-8924b14e9a74", "name": "The updated external promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d506842f-7a54-4f4f-a339-8924b14e9a74" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c0647236-73b9-4343-ab23-505f84403ff3" }, { "name": "Delete an external promotion", "id": "d257313a-e77d-46fe-906c-0db31cacfc9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId" ], "variable": [ { "id": "f0a5cb03-e35b-4dcb-bf2c-04967b423480", "key": "externalPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an external promotion" }, "response": [ { "id": "0a494240-ba1e-4a32-a160-56852182a8b7", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions/:externalPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions", ":externalPromotionId" ], "variable": [ { "key": "externalPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0a494240-ba1e-4a32-a160-56852182a8b7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d257313a-e77d-46fe-906c-0db31cacfc9d" } ], "id": "0b302c16-aae8-474e-a168-5a325a32acf0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0b302c16-aae8-474e-a168-5a325a32acf0" }, { "name": "List all external promotions", "id": "d51ef614-9fe7-4395-8264-4cd90614853a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_promotions", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions" ] }, "description": "List all external promotions" }, "response": [ { "id": "41c70e59-7493-40c1-b6b3-cbb91e60fc01", "name": "A list of external promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_promotions", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"external_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"external_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"external_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-41c70e59-7493-40c1-b6b3-cbb91e60fc01" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d51ef614-9fe7-4395-8264-4cd90614853a" }, { "name": "Create an external promotion", "id": "6e4db1da-19e5-4f6d-9d0c-fcb81ccd5ef3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"promotion_url\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"external_includes\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_promotions", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions" ] }, "description": "Create an external promotion" }, "response": [ { "id": "7ece3120-e245-4992-aadf-79a44b935e8a", "name": "The created external promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"promotion_url\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"external_includes\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_promotions", "host": [ "{{baseUrl}}" ], "path": [ "external_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"promotion_url\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7ece3120-e245-4992-aadf-79a44b935e8a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6e4db1da-19e5-4f6d-9d0c-fcb81ccd5ef3" } ], "id": "904fb014-2342-491c-9110-22d80bb686b4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-904fb014-2342-491c-9110-22d80bb686b4" }, { "name": "external_tax_calculators", "item": [ { "name": "{externalTaxCalculatorId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the external tax calculator", "id": "a0ee5199-262d-4751-8be6-c4dc54563530", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/markets", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "markets" ], "variable": [ { "id": "3b2bccce-d9cf-401c-88c4-7f7df37d51bc", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the external tax calculator" }, "response": [ { "id": "59a350c7-239b-4cfd-9478-e10863cf5a9d", "name": "The markets associated to the external tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/markets", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "markets" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-59a350c7-239b-4cfd-9478-e10863cf5a9d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a0ee5199-262d-4751-8be6-c4dc54563530" } ], "id": "c30d3ef7-2001-42ea-870d-19168a29fbe5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c30d3ef7-2001-42ea-870d-19168a29fbe5" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the external tax calculator", "id": "b8d1209b-bcb4-4664-9b97-e9f2a177ea9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "attachments" ], "variable": [ { "id": "d3c72745-ef13-4326-83a3-cc1840e7987d", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the external tax calculator" }, "response": [ { "id": "85313c0d-a679-4d2f-872c-edd9ae7d9cee", "name": "The attachments associated to the external tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "attachments" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-85313c0d-a679-4d2f-872c-edd9ae7d9cee" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b8d1209b-bcb4-4664-9b97-e9f2a177ea9d" } ], "id": "f080ae52-63eb-4cb2-bee4-95a37401d394", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f080ae52-63eb-4cb2-bee4-95a37401d394" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the external tax calculator", "id": "d505a3ce-a726-4dc0-9227-3883ba7e0332", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/events", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "events" ], "variable": [ { "id": "564de99a-cb43-498f-8b17-fc2e6dcaad29", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the external tax calculator" }, "response": [ { "id": "dee6ac5d-a16a-4956-bc4d-deb2abaa67b8", "name": "The events associated to the external tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/events", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "events" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dee6ac5d-a16a-4956-bc4d-deb2abaa67b8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d505a3ce-a726-4dc0-9227-3883ba7e0332" } ], "id": "ad316c4a-c47d-4649-a98a-cb70ba6843d6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ad316c4a-c47d-4649-a98a-cb70ba6843d6" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the external tax calculator", "id": "32328ce8-f87e-4f3a-aba8-03b54f8dd07c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "event_stores" ], "variable": [ { "id": "251dc2de-36ae-41b7-8b0a-bf57e2a14c66", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the external tax calculator" }, "response": [ { "id": "1933ec7d-cf36-4a36-aab1-631f439a13e7", "name": "The event_stores associated to the external tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId", "event_stores" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1933ec7d-cf36-4a36-aab1-631f439a13e7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-32328ce8-f87e-4f3a-aba8-03b54f8dd07c" } ], "id": "44ba2bc3-598f-4111-90d6-c33e21bfbbaf", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-44ba2bc3-598f-4111-90d6-c33e21bfbbaf" }, { "name": "Retrieve an external tax calculator", "id": "08eeceab-b8a3-4ef9-9108-8239f8169e18", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId" ], "variable": [ { "id": "220ebdef-5ff0-4b6b-a435-70d2d61558d1", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an external tax calculator" }, "response": [ { "id": "458927df-15e9-45eb-b741-cabbb562f863", "name": "The external tax calculator object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-458927df-15e9-45eb-b741-cabbb562f863" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-08eeceab-b8a3-4ef9-9108-8239f8169e18" }, { "name": "Update an external tax calculator", "id": "2459f7b1-c148-427d-afa2-abc4772baeda", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_tax_calculators\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId" ], "variable": [ { "id": "67134766-72a7-49e5-bdfc-fabfa7cfaba2", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an external tax calculator" }, "response": [ { "id": "24791316-7bc7-4ef8-8b97-d0d412ed4c28", "name": "The updated external tax calculator object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_tax_calculators\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-24791316-7bc7-4ef8-8b97-d0d412ed4c28" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2459f7b1-c148-427d-afa2-abc4772baeda" }, { "name": "Delete an external tax calculator", "id": "dd74e89b-4e3c-4d6b-bd71-7412bf7fe790", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId" ], "variable": [ { "id": "1b530ca0-9bb5-4780-a949-ab89a72207ce", "key": "externalTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an external tax calculator" }, "response": [ { "id": "c69a287c-7d09-4d40-8650-30dadb345cd5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators/:externalTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators", ":externalTaxCalculatorId" ], "variable": [ { "key": "externalTaxCalculatorId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c69a287c-7d09-4d40-8650-30dadb345cd5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dd74e89b-4e3c-4d6b-bd71-7412bf7fe790" } ], "id": "173c8893-d259-457a-b17a-07f8b48364c0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-173c8893-d259-457a-b17a-07f8b48364c0" }, { "name": "List all external tax calculators", "id": "a33020fd-489c-4562-966a-2a0d3e6ad19c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators" ] }, "description": "List all external tax calculators" }, "response": [ { "id": "06a6aabe-f394-4abf-a035-fec365d84f0a", "name": "A list of external tax calculator objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/external_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"external_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"external_tax_calculators\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"external_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-06a6aabe-f394-4abf-a035-fec365d84f0a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a33020fd-489c-4562-966a-2a0d3e6ad19c" }, { "name": "Create an external tax calculator", "id": "e3605c45-c043-4724-b443-4d84f36fa1a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_tax_calculators\",\n \"attributes\": {\n \"name\": \"\",\n \"tax_calculator_url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"external_includes\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators" ] }, "description": "Create an external tax calculator" }, "response": [ { "id": "cd533e5d-4c22-499b-a77e-c8a09a1f7a6d", "name": "The created external tax calculator object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"external_tax_calculators\",\n \"attributes\": {\n \"name\": \"\",\n \"tax_calculator_url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"external_includes\": [\n \"\",\n \"\"\n ]\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/external_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "external_tax_calculators" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"external_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"tax_calculator_url\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd533e5d-4c22-499b-a77e-c8a09a1f7a6d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e3605c45-c043-4724-b443-4d84f36fa1a4" } ], "id": "fcaafa83-40da-4796-bb80-825a408b4bd8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fcaafa83-40da-4796-bb80-825a408b4bd8" }, { "name": "fixed_amount_promotions", "item": [ { "name": "{fixedAmountPromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the fixed amount promotion", "id": "199bb36e-fff2-4832-b14e-0d89b99046e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "market" ], "variable": [ { "id": "9af9e85a-2766-4878-9a58-81711eda83b7", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the fixed amount promotion" }, "response": [ { "id": "0830167c-a17b-457c-a744-a73fd727a210", "name": "The market associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "market" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0830167c-a17b-457c-a744-a73fd727a210" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-199bb36e-fff2-4832-b14e-0d89b99046e1" } ], "id": "6a27ffc7-9706-4dc9-8018-d2bf44e694b3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6a27ffc7-9706-4dc9-8018-d2bf44e694b3" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the fixed amount promotion", "id": "182a8d13-7a6e-4123-ab23-2cce3861abc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "50e4892c-50c5-46f2-84a3-346097d8172d", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the fixed amount promotion" }, "response": [ { "id": "4963a01f-38b2-482f-a48c-9ae99a78f4dc", "name": "The order_amount_promotion_rule associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4963a01f-38b2-482f-a48c-9ae99a78f4dc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-182a8d13-7a6e-4123-ab23-2cce3861abc4" } ], "id": "6f8bc323-3b43-4d17-8012-0255ff3b4e09", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6f8bc323-3b43-4d17-8012-0255ff3b4e09" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the fixed amount promotion", "id": "57b71811-0004-4a04-be69-f6d7b3eb8ab3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "ed8f2e6e-bbcc-4510-8490-1c512e411d63", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the fixed amount promotion" }, "response": [ { "id": "de825098-5857-42b4-b303-4fd66250b964", "name": "The sku_list_promotion_rule associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-de825098-5857-42b4-b303-4fd66250b964" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-57b71811-0004-4a04-be69-f6d7b3eb8ab3" } ], "id": "187eb8a7-f66b-4451-aff7-5688c6a76383", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-187eb8a7-f66b-4451-aff7-5688c6a76383" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the fixed amount promotion", "id": "9384784f-4a1e-487a-9947-9a3c056dcebc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "944ecec0-3f5e-4c33-89a1-1ef092fd0ae4", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the fixed amount promotion" }, "response": [ { "id": "03176a8c-9342-4250-b23c-be1f5ce9ad61", "name": "The coupon_codes_promotion_rule associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-03176a8c-9342-4250-b23c-be1f5ce9ad61" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9384784f-4a1e-487a-9947-9a3c056dcebc" } ], "id": "30ea5abb-b901-4e0a-8950-a3f187d070c2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-30ea5abb-b901-4e0a-8950-a3f187d070c2" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the fixed amount promotion", "id": "bd731dcb-433c-4b03-8408-33f36ec01ea9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "custom_promotion_rule" ], "variable": [ { "id": "33f87055-ab7a-4eb5-9e50-42e2b7f11df1", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the fixed amount promotion" }, "response": [ { "id": "52cd42af-2bba-4110-841d-5f9852349c0c", "name": "The custom_promotion_rule associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "custom_promotion_rule" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-52cd42af-2bba-4110-841d-5f9852349c0c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bd731dcb-433c-4b03-8408-33f36ec01ea9" } ], "id": "b433e394-349a-4b8d-b2b2-d9e9710d5387", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b433e394-349a-4b8d-b2b2-d9e9710d5387" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the fixed amount promotion", "id": "d1179fe2-827b-45e9-bb32-ab98eec418f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "sku_list" ], "variable": [ { "id": "f5eeb983-ab7f-45b9-a6b7-c54fdce10142", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the fixed amount promotion" }, "response": [ { "id": "b5e03545-ce8c-4e63-bdc6-198236933521", "name": "The sku_list associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "sku_list" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b5e03545-ce8c-4e63-bdc6-198236933521" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d1179fe2-827b-45e9-bb32-ab98eec418f5" } ], "id": "8238213f-e7f0-4fa3-91a5-cccd1b52a29d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8238213f-e7f0-4fa3-91a5-cccd1b52a29d" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the fixed amount promotion", "id": "46e99700-f8ba-4bb0-844d-96336196aa8f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "coupons" ], "variable": [ { "id": "7d0d5576-3f23-44d6-9ff3-e62eaeb68f26", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the fixed amount promotion" }, "response": [ { "id": "5613382f-847a-4788-bb75-afb0d6ad9451", "name": "The coupons associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "coupons" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5613382f-847a-4788-bb75-afb0d6ad9451" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-46e99700-f8ba-4bb0-844d-96336196aa8f" } ], "id": "5f347e1f-17c0-4649-a74a-41535082d02d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5f347e1f-17c0-4649-a74a-41535082d02d" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the fixed amount promotion", "id": "d01a8e6a-08b0-4781-bc2f-d836910dd54d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "attachments" ], "variable": [ { "id": "3954817b-8452-4804-b7e8-9d56b84d8e4d", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the fixed amount promotion" }, "response": [ { "id": "525e6944-dcb3-4c0e-9dbd-8ec7253b6305", "name": "The attachments associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "attachments" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-525e6944-dcb3-4c0e-9dbd-8ec7253b6305" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d01a8e6a-08b0-4781-bc2f-d836910dd54d" } ], "id": "75dbd1a3-82d1-475f-a4c6-d2db916bc9d9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-75dbd1a3-82d1-475f-a4c6-d2db916bc9d9" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the fixed amount promotion", "id": "30d31894-56e5-418a-9898-7de91db017bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "events" ], "variable": [ { "id": "05a36f08-06aa-4e33-a571-8c8f5f8e4ad2", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the fixed amount promotion" }, "response": [ { "id": "e27381dc-c30d-4949-bb4a-1726c06d8a9c", "name": "The events associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "events" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e27381dc-c30d-4949-bb4a-1726c06d8a9c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-30d31894-56e5-418a-9898-7de91db017bb" } ], "id": "1f6696cb-0cb2-4012-aa8b-b3673176be0a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1f6696cb-0cb2-4012-aa8b-b3673176be0a" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the fixed amount promotion", "id": "bed838c0-6042-4d5a-a642-73aebe82c10c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "tags" ], "variable": [ { "id": "ae4073cf-fcb0-43e3-9407-2824c27bb7c8", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the fixed amount promotion" }, "response": [ { "id": "2be5e0d2-25f3-4f5e-a0e0-51ef01ca99d6", "name": "The tags associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "tags" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2be5e0d2-25f3-4f5e-a0e0-51ef01ca99d6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bed838c0-6042-4d5a-a642-73aebe82c10c" } ], "id": "63faa600-b010-49ee-9fba-2f7dc4b830ea", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-63faa600-b010-49ee-9fba-2f7dc4b830ea" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the fixed amount promotion", "id": "f0ce3fd1-d497-4fab-96da-cf92d9ee2443", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "event_stores" ], "variable": [ { "id": "6a832172-ff45-4ea5-8988-5641bab1fa2e", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the fixed amount promotion" }, "response": [ { "id": "af1ab654-89c9-4f52-982e-5ad62db56303", "name": "The event_stores associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "event_stores" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-af1ab654-89c9-4f52-982e-5ad62db56303" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f0ce3fd1-d497-4fab-96da-cf92d9ee2443" } ], "id": "872902d2-7601-4e65-bbe5-262ceb139c31", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-872902d2-7601-4e65-bbe5-262ceb139c31" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the fixed amount promotion", "id": "88c5a4be-2e09-41d5-bcf8-7059e1b432aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "skus" ], "variable": [ { "id": "53d68a77-09e3-4761-927a-cb6472b7221f", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the fixed amount promotion" }, "response": [ { "id": "b484583f-5be0-4c4a-9d77-ab6c70b1eb14", "name": "The skus associated to the fixed amount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId", "skus" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b484583f-5be0-4c4a-9d77-ab6c70b1eb14" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-88c5a4be-2e09-41d5-bcf8-7059e1b432aa" } ], "id": "91b266a4-e475-48a8-8822-8a9a10e7d858", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-91b266a4-e475-48a8-8822-8a9a10e7d858" }, { "name": "Retrieve a fixed amount promotion", "id": "249484c9-46b5-4846-aeef-8144f14746f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId" ], "variable": [ { "id": "d647c582-c764-4ae5-a30f-c12c7acb5d30", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a fixed amount promotion" }, "response": [ { "id": "fad46e64-a0d7-402e-a450-967e55d5f51d", "name": "The fixed amount promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fad46e64-a0d7-402e-a450-967e55d5f51d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-249484c9-46b5-4846-aeef-8144f14746f4" }, { "name": "Update a fixed amount promotion", "id": "d9f2bf73-1878-40aa-afbf-1149b1ad3016", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_amount_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId" ], "variable": [ { "id": "c3725e80-0cc0-4c7e-bcb0-2e21bab6303a", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a fixed amount promotion" }, "response": [ { "id": "928b54e4-dfe4-49b2-9c54-304af6e69a54", "name": "The updated fixed amount promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_amount_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-928b54e4-dfe4-49b2-9c54-304af6e69a54" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9f2bf73-1878-40aa-afbf-1149b1ad3016" }, { "name": "Delete a fixed amount promotion", "id": "cd5c0ffa-a7c2-4ed8-8c00-bc65c5cbd55e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId" ], "variable": [ { "id": "e585855e-cd43-4694-84b7-749ddb141ee6", "key": "fixedAmountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a fixed amount promotion" }, "response": [ { "id": "53ef6b76-3c77-4942-8b48-779d1ba621fb", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions/:fixedAmountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions", ":fixedAmountPromotionId" ], "variable": [ { "key": "fixedAmountPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-53ef6b76-3c77-4942-8b48-779d1ba621fb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cd5c0ffa-a7c2-4ed8-8c00-bc65c5cbd55e" } ], "id": "c4b482b0-9c87-4ef2-a2d7-81064a677029", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c4b482b0-9c87-4ef2-a2d7-81064a677029" }, { "name": "List all fixed amount promotions", "id": "f35b50b4-c83e-495e-bb8f-d531654aa1eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions" ] }, "description": "List all fixed amount promotions" }, "response": [ { "id": "7c4dd95f-0881-4405-897d-440989254e65", "name": "A list of fixed amount promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_amount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7c4dd95f-0881-4405-897d-440989254e65" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f35b50b4-c83e-495e-bb8f-d531654aa1eb" }, { "name": "Create a fixed amount promotion", "id": "43fbd49e-8c09-4eb6-96ff-c5847b2e7dae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_amount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"fixed_amount_cents\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_amount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions" ] }, "description": "Create a fixed amount promotion" }, "response": [ { "id": "c48c81a4-cb79-4a8f-981f-d46f264e3c22", "name": "The created fixed amount promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_amount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"fixed_amount_cents\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_amount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_amount_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c48c81a4-cb79-4a8f-981f-d46f264e3c22" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-43fbd49e-8c09-4eb6-96ff-c5847b2e7dae" } ], "id": "f36882af-9ae7-4910-877a-e02223cf71e3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f36882af-9ae7-4910-877a-e02223cf71e3" }, { "name": "fixed_price_promotions", "item": [ { "name": "{fixedPricePromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the fixed price promotion", "id": "1a45b289-39ee-40ee-a4c3-88b57b90b93a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "market" ], "variable": [ { "id": "b8951b32-5c75-4b63-aaba-16fc35fabd34", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the fixed price promotion" }, "response": [ { "id": "10532b03-12d0-489b-b18b-5899f6a89952", "name": "The market associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "market" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-10532b03-12d0-489b-b18b-5899f6a89952" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1a45b289-39ee-40ee-a4c3-88b57b90b93a" } ], "id": "09f40a76-3f58-4ab7-99e2-0f652ecab0b9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-09f40a76-3f58-4ab7-99e2-0f652ecab0b9" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the fixed price promotion", "id": "9c01c779-5663-482c-852e-4932c13f3afe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "d1e5cb61-4b95-498a-b2dc-09d47614ebd3", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the fixed price promotion" }, "response": [ { "id": "ca3e21d6-c8a6-4a62-9580-334d1f9b31c3", "name": "The order_amount_promotion_rule associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ca3e21d6-c8a6-4a62-9580-334d1f9b31c3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9c01c779-5663-482c-852e-4932c13f3afe" } ], "id": "86d78448-fae1-4af7-b8da-58a94a0978d6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-86d78448-fae1-4af7-b8da-58a94a0978d6" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the fixed price promotion", "id": "a49d0cd5-c1d0-4641-ada0-9f02df39840b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "74cb29e7-655a-4918-bd07-28330e3aa757", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the fixed price promotion" }, "response": [ { "id": "7242a466-7203-44d4-ace0-66f2e2d2f5d6", "name": "The sku_list_promotion_rule associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7242a466-7203-44d4-ace0-66f2e2d2f5d6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a49d0cd5-c1d0-4641-ada0-9f02df39840b" } ], "id": "488db430-568e-48e5-a16d-80288cc363fa", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-488db430-568e-48e5-a16d-80288cc363fa" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the fixed price promotion", "id": "297c1532-729e-4ac3-a7e1-1edf42db8b88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "04965a87-0f8e-4df8-a7db-9d583daa4af2", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the fixed price promotion" }, "response": [ { "id": "b7039bcb-687d-4e92-b16e-016c4d142c3e", "name": "The coupon_codes_promotion_rule associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b7039bcb-687d-4e92-b16e-016c4d142c3e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-297c1532-729e-4ac3-a7e1-1edf42db8b88" } ], "id": "69f7337e-f666-4a3b-af71-0aafb7560906", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-69f7337e-f666-4a3b-af71-0aafb7560906" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the fixed price promotion", "id": "14b1832b-24a9-482d-9990-742fd5350288", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "custom_promotion_rule" ], "variable": [ { "id": "6bb865d1-eeb6-4047-8a6d-0db6f3757a80", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the fixed price promotion" }, "response": [ { "id": "1f034964-9280-4f85-a18c-535752cdfffa", "name": "The custom_promotion_rule associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "custom_promotion_rule" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1f034964-9280-4f85-a18c-535752cdfffa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-14b1832b-24a9-482d-9990-742fd5350288" } ], "id": "619aab8c-2e0c-4878-8c23-be46739e1225", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-619aab8c-2e0c-4878-8c23-be46739e1225" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the fixed price promotion", "id": "32e05c3c-1cc1-4758-b1a1-8add5f6fe1bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "sku_list" ], "variable": [ { "id": "8e4a9443-8065-4fd7-91e2-f46a0e95d266", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the fixed price promotion" }, "response": [ { "id": "b602f714-8d1f-4a66-a36c-decf911924f6", "name": "The sku_list associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "sku_list" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b602f714-8d1f-4a66-a36c-decf911924f6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-32e05c3c-1cc1-4758-b1a1-8add5f6fe1bd" } ], "id": "5d0d6e93-f798-44ff-abd6-cf2b57f65822", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5d0d6e93-f798-44ff-abd6-cf2b57f65822" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the fixed price promotion", "id": "6a2f7e2c-590e-4278-a874-982a89d138b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "coupons" ], "variable": [ { "id": "434ea032-2e7d-46cc-87e7-e8cdc97860bb", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the fixed price promotion" }, "response": [ { "id": "b03c6c0e-9db7-4511-86d4-a4d001fc190f", "name": "The coupons associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "coupons" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b03c6c0e-9db7-4511-86d4-a4d001fc190f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6a2f7e2c-590e-4278-a874-982a89d138b2" } ], "id": "8908dc4d-78a4-45ba-a16f-bb07cdcebac4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8908dc4d-78a4-45ba-a16f-bb07cdcebac4" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the fixed price promotion", "id": "4a554bf1-b929-4b9b-af04-0de8d7e427cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "attachments" ], "variable": [ { "id": "ea5bd8d2-4503-481d-aa1d-4b208d985a7e", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the fixed price promotion" }, "response": [ { "id": "e97abfc2-2d1a-4586-9d13-cacdaaab0ec0", "name": "The attachments associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "attachments" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e97abfc2-2d1a-4586-9d13-cacdaaab0ec0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4a554bf1-b929-4b9b-af04-0de8d7e427cd" } ], "id": "883654ef-dcc3-4492-8f6a-4a500925963e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-883654ef-dcc3-4492-8f6a-4a500925963e" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the fixed price promotion", "id": "e35a1979-c3ab-471e-a020-98de439f7701", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "events" ], "variable": [ { "id": "cbc0f8d2-a548-411f-b328-f8ebb50f265d", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the fixed price promotion" }, "response": [ { "id": "c0414496-932a-43b1-81b4-54d65004c5f9", "name": "The events associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "events" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c0414496-932a-43b1-81b4-54d65004c5f9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e35a1979-c3ab-471e-a020-98de439f7701" } ], "id": "b6a3b718-479e-4e73-9a0d-9da204981794", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b6a3b718-479e-4e73-9a0d-9da204981794" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the fixed price promotion", "id": "8b22307b-a3ba-46ea-bac1-17d537378bf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "tags" ], "variable": [ { "id": "83a865de-e46d-414a-97d3-7b9691bf1277", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the fixed price promotion" }, "response": [ { "id": "3f09cc8a-6baa-46e7-9063-bb8dea840fca", "name": "The tags associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "tags" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3f09cc8a-6baa-46e7-9063-bb8dea840fca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8b22307b-a3ba-46ea-bac1-17d537378bf7" } ], "id": "c60ad990-4930-4f76-8522-66c9f6984817", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c60ad990-4930-4f76-8522-66c9f6984817" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the fixed price promotion", "id": "b6216e6a-b228-4746-9174-6fcc19e793ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "event_stores" ], "variable": [ { "id": "77d269b0-9516-4d13-8050-380f50e3ec6f", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the fixed price promotion" }, "response": [ { "id": "a2e0f61c-8e11-4ac9-a903-4d195bcb17ef", "name": "The event_stores associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "event_stores" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a2e0f61c-8e11-4ac9-a903-4d195bcb17ef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b6216e6a-b228-4746-9174-6fcc19e793ea" } ], "id": "c1ee695e-1429-472d-907d-b76561a224fa", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c1ee695e-1429-472d-907d-b76561a224fa" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the fixed price promotion", "id": "82b8b97e-9943-4cb2-9f14-a1df52fca83c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "skus" ], "variable": [ { "id": "0b6cfc4a-1a1f-4700-a990-e44b7787f2d2", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the fixed price promotion" }, "response": [ { "id": "44d7dc6a-1024-40d3-bd80-f5c8016aded5", "name": "The skus associated to the fixed price promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId", "skus" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-44d7dc6a-1024-40d3-bd80-f5c8016aded5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-82b8b97e-9943-4cb2-9f14-a1df52fca83c" } ], "id": "e796a9f4-aea4-4392-b9e0-632b600fc9fb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e796a9f4-aea4-4392-b9e0-632b600fc9fb" }, { "name": "Retrieve a fixed price promotion", "id": "f2e02f8a-ee53-4e14-beea-9f6a35b9f3d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId" ], "variable": [ { "id": "21cc8dd4-947e-4a61-b502-4db167c808be", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a fixed price promotion" }, "response": [ { "id": "674d3731-72e1-4760-9669-b4a0cffbd9bd", "name": "The fixed price promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-674d3731-72e1-4760-9669-b4a0cffbd9bd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f2e02f8a-ee53-4e14-beea-9f6a35b9f3d2" }, { "name": "Update a fixed price promotion", "id": "cb0054a9-0645-4184-8b37-c3f629461035", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_price_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId" ], "variable": [ { "id": "d3a66244-5e49-49be-9824-da0e4b7cc7af", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a fixed price promotion" }, "response": [ { "id": "c099a8db-96e2-4529-9d4b-582e0f6e99b4", "name": "The updated fixed price promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_price_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c099a8db-96e2-4529-9d4b-582e0f6e99b4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cb0054a9-0645-4184-8b37-c3f629461035" }, { "name": "Delete a fixed price promotion", "id": "82499198-073b-4001-91ee-29151bd17f97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId" ], "variable": [ { "id": "edc45715-7209-44de-8c13-2f53136d1a69", "key": "fixedPricePromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a fixed price promotion" }, "response": [ { "id": "d24952b9-cd4a-4ed9-a5ab-5091bb61a4b9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions/:fixedPricePromotionId", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions", ":fixedPricePromotionId" ], "variable": [ { "key": "fixedPricePromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d24952b9-cd4a-4ed9-a5ab-5091bb61a4b9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-82499198-073b-4001-91ee-29151bd17f97" } ], "id": "2fc072e9-5137-4cb5-8a46-735b79e13d6d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2fc072e9-5137-4cb5-8a46-735b79e13d6d" }, { "name": "List all fixed price promotions", "id": "83190a8f-efd4-456d-9175-9fab5d038029", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions" ] }, "description": "List all fixed price promotions" }, "response": [ { "id": "68a8bd99-cf06-4d1b-9ee7-a5152e24fa8d", "name": "A list of fixed price promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/fixed_price_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-68a8bd99-cf06-4d1b-9ee7-a5152e24fa8d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83190a8f-efd4-456d-9175-9fab5d038029" }, { "name": "Create a fixed price promotion", "id": "61322855-a7e8-4c5d-abbd-8926759e80e2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_price_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"fixed_amount_cents\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_price_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions" ] }, "description": "Create a fixed price promotion" }, "response": [ { "id": "6ef2ca24-c311-4965-927e-280bfa4a8a29", "name": "The created fixed price promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"fixed_price_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"fixed_amount_cents\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fixed_price_promotions", "host": [ "{{baseUrl}}" ], "path": [ "fixed_price_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"fixed_amount_cents\": \"\",\n \"fixed_amount_float\": \"\",\n \"formatted_fixed_amount\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6ef2ca24-c311-4965-927e-280bfa4a8a29" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-61322855-a7e8-4c5d-abbd-8926759e80e2" } ], "id": "743d81c2-e32a-443b-85bf-d4be403dad08", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-743d81c2-e32a-443b-85bf-d4be403dad08" }, { "name": "flex_promotions", "item": [ { "name": "{flexPromotionId}", "item": [ { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the flex promotion", "id": "d38781a2-1d95-4964-a4d1-65a35226c6f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "b07b1310-f462-44a6-b034-dfcec0f85c7d", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the flex promotion" }, "response": [ { "id": "729f708e-fc31-4fc0-9424-b037f6de8fa7", "name": "The coupon_codes_promotion_rule associated to the flex promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-729f708e-fc31-4fc0-9424-b037f6de8fa7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d38781a2-1d95-4964-a4d1-65a35226c6f7" } ], "id": "57ff82b9-1c38-4f5f-9f62-d2e53cdf900e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-57ff82b9-1c38-4f5f-9f62-d2e53cdf900e" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the flex promotion", "id": "cf34f8f4-1b93-4660-ab28-ea6c914ea193", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "coupons" ], "variable": [ { "id": "1577f637-f8d3-4948-ab90-0a427555a501", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the flex promotion" }, "response": [ { "id": "a691ba95-7c29-47d0-90d3-c5fff5fd7506", "name": "The coupons associated to the flex promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "coupons" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a691ba95-7c29-47d0-90d3-c5fff5fd7506" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cf34f8f4-1b93-4660-ab28-ea6c914ea193" } ], "id": "b46b1a51-d13d-4395-aba5-0e7fa2256884", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b46b1a51-d13d-4395-aba5-0e7fa2256884" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the flex promotion", "id": "444d936a-eb32-46d4-804f-024505c69041", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "attachments" ], "variable": [ { "id": "127a6e18-6540-4533-9183-7b8c1772bcfd", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the flex promotion" }, "response": [ { "id": "eabd6668-4805-49b8-a1c2-73d7d087c227", "name": "The attachments associated to the flex promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "attachments" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-eabd6668-4805-49b8-a1c2-73d7d087c227" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-444d936a-eb32-46d4-804f-024505c69041" } ], "id": "0216d812-db57-4439-b217-85aeb28e301c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0216d812-db57-4439-b217-85aeb28e301c" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the flex promotion", "id": "9f08d839-b106-494f-8a03-ef74d21c443c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "events" ], "variable": [ { "id": "bb3e1c04-2c61-40e7-9ca3-b4015a22078b", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the flex promotion" }, "response": [ { "id": "e1f516ea-ef3d-4ef9-9503-b85a31ef400c", "name": "The events associated to the flex promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "events" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e1f516ea-ef3d-4ef9-9503-b85a31ef400c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9f08d839-b106-494f-8a03-ef74d21c443c" } ], "id": "40da15cd-05eb-4c81-9754-a2a2c19079af", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-40da15cd-05eb-4c81-9754-a2a2c19079af" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the flex promotion", "id": "64130aa9-0dbf-4738-be99-15a59ae6bbea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "tags" ], "variable": [ { "id": "2da881ed-7cb4-4c08-b6df-02edd964bcd8", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the flex promotion" }, "response": [ { "id": "1cedfe16-3d36-47ff-b8ce-61a25e5d970c", "name": "The tags associated to the flex promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "tags" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1cedfe16-3d36-47ff-b8ce-61a25e5d970c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-64130aa9-0dbf-4738-be99-15a59ae6bbea" } ], "id": "8ff20b52-302c-4dfd-b1c5-b542bf56c1c5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8ff20b52-302c-4dfd-b1c5-b542bf56c1c5" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the flex promotion", "id": "d0209675-3012-473b-89ec-1f7020c1dc74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "event_stores" ], "variable": [ { "id": "466e5763-d8bf-49e5-b63e-405bdbc6350f", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the flex promotion" }, "response": [ { "id": "1ba9353e-e385-4f9f-898e-dd01c0f848ca", "name": "The event_stores associated to the flex promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId", "event_stores" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1ba9353e-e385-4f9f-898e-dd01c0f848ca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d0209675-3012-473b-89ec-1f7020c1dc74" } ], "id": "0b29cc23-e774-481a-9f36-8a288c1b9027", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0b29cc23-e774-481a-9f36-8a288c1b9027" }, { "name": "Retrieve a flex promotion", "id": "dcf1049c-2f87-4de7-a95e-1df802ec2d74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId" ], "variable": [ { "id": "20f487e6-7282-41ad-bee8-0889926d7520", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a flex promotion" }, "response": [ { "id": "5eb1be2b-2528-4a54-a675-f1d6cb463f22", "name": "The flex promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"flex_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"rules\": {},\n \"rule_outcomes\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5eb1be2b-2528-4a54-a675-f1d6cb463f22" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dcf1049c-2f87-4de7-a95e-1df802ec2d74" }, { "name": "Update a flex promotion", "id": "98227934-f18e-4ecf-b42d-77e28dd2b866", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"flex_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"rules\": {},\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId" ], "variable": [ { "id": "f26230e3-2982-4248-9097-450df9881722", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a flex promotion" }, "response": [ { "id": "9510e05a-5496-4659-ad7d-111208e3c580", "name": "The updated flex promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"flex_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"rules\": {},\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"flex_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"rules\": {},\n \"rule_outcomes\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9510e05a-5496-4659-ad7d-111208e3c580" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98227934-f18e-4ecf-b42d-77e28dd2b866" }, { "name": "Delete a flex promotion", "id": "b7af8eaf-6fd3-4d3a-950e-31fa870cc0ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId" ], "variable": [ { "id": "72a780c5-e274-403f-a710-86393b894351", "key": "flexPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a flex promotion" }, "response": [ { "id": "75f81210-2f1b-4324-bfae-22ad3132caf4", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions/:flexPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions", ":flexPromotionId" ], "variable": [ { "key": "flexPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-75f81210-2f1b-4324-bfae-22ad3132caf4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b7af8eaf-6fd3-4d3a-950e-31fa870cc0ea" } ], "id": "d8ddbb0e-81c3-4667-8834-b6c82d46a37e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d8ddbb0e-81c3-4667-8834-b6c82d46a37e" }, { "name": "List all flex promotions", "id": "03006a42-24a3-4d13-9db8-c17bb48d09f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/flex_promotions", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions" ] }, "description": "List all flex promotions" }, "response": [ { "id": "a30a2abc-1f04-4d5d-be5c-660904d90ba8", "name": "A list of flex promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/flex_promotions", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"flex_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"rules\": {},\n \"rule_outcomes\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"flex_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"rules\": {},\n \"rule_outcomes\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a30a2abc-1f04-4d5d-be5c-660904d90ba8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-03006a42-24a3-4d13-9db8-c17bb48d09f2" }, { "name": "Create a flex promotion", "id": "2112c6ba-b31e-4567-9d06-26948be93413", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"flex_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"rules\": {},\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flex_promotions", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions" ] }, "description": "Create a flex promotion" }, "response": [ { "id": "f87d37f3-aa4d-4f97-8bef-f84f57c471d1", "name": "The created flex promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"flex_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"rules\": {},\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/flex_promotions", "host": [ "{{baseUrl}}" ], "path": [ "flex_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"flex_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"rules\": {},\n \"rule_outcomes\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f87d37f3-aa4d-4f97-8bef-f84f57c471d1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2112c6ba-b31e-4567-9d06-26948be93413" } ], "id": "2706dca5-8b73-4997-a161-de9164f56207", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2706dca5-8b73-4997-a161-de9164f56207" }, { "name": "free_gift_promotions", "item": [ { "name": "{freeGiftPromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the free gift promotion", "id": "f86c9eab-dcc2-4700-b5ec-6fad18542ad9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "market" ], "variable": [ { "id": "29a75cbb-93a1-4878-a5cc-2849fc4153eb", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the free gift promotion" }, "response": [ { "id": "5d8a6f1d-c029-438d-84a0-e5741af69895", "name": "The market associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "market" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5d8a6f1d-c029-438d-84a0-e5741af69895" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f86c9eab-dcc2-4700-b5ec-6fad18542ad9" } ], "id": "f3149df1-8aab-416c-bf9a-a3ca82c2722a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f3149df1-8aab-416c-bf9a-a3ca82c2722a" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the free gift promotion", "id": "60a6e1b2-6782-4b0c-8458-38c929088f80", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "caa6230b-255e-472f-9567-1675b2b2bfd4", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the free gift promotion" }, "response": [ { "id": "27b6956d-76ac-42b9-b8ab-7dbb14d81368", "name": "The order_amount_promotion_rule associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-27b6956d-76ac-42b9-b8ab-7dbb14d81368" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-60a6e1b2-6782-4b0c-8458-38c929088f80" } ], "id": "f9c9dc33-5ca6-42f8-a0b2-cdcdb6e09747", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f9c9dc33-5ca6-42f8-a0b2-cdcdb6e09747" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the free gift promotion", "id": "b149c85b-e181-47f2-8e58-ec6bdde334b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "8a58158e-82ae-4908-9f54-7db2c0d2c932", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the free gift promotion" }, "response": [ { "id": "3970506f-d84d-4b13-822c-989b276724f3", "name": "The sku_list_promotion_rule associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3970506f-d84d-4b13-822c-989b276724f3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b149c85b-e181-47f2-8e58-ec6bdde334b8" } ], "id": "1d166c43-cf20-4035-bfc6-eb04949186f9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1d166c43-cf20-4035-bfc6-eb04949186f9" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the free gift promotion", "id": "367fa4ec-7b73-4461-b936-d383140889b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "8d5ec823-3b60-4360-8ce4-88074b726451", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the free gift promotion" }, "response": [ { "id": "6d80c7a9-4662-4010-a522-deb4f0c51be1", "name": "The coupon_codes_promotion_rule associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6d80c7a9-4662-4010-a522-deb4f0c51be1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-367fa4ec-7b73-4461-b936-d383140889b7" } ], "id": "643bcaa2-516a-4f0c-a74a-d1dfc2b0302e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-643bcaa2-516a-4f0c-a74a-d1dfc2b0302e" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the free gift promotion", "id": "63588c16-6958-40bb-9e31-82a6d429ce60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "custom_promotion_rule" ], "variable": [ { "id": "d4e353a5-4d89-4eef-a63f-7d72a146b93d", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the free gift promotion" }, "response": [ { "id": "0e040cba-fcc8-4442-a3ee-78cf0155baf2", "name": "The custom_promotion_rule associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "custom_promotion_rule" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0e040cba-fcc8-4442-a3ee-78cf0155baf2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-63588c16-6958-40bb-9e31-82a6d429ce60" } ], "id": "af4ce6c9-ab56-45be-8988-8cffaf193bd6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-af4ce6c9-ab56-45be-8988-8cffaf193bd6" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the free gift promotion", "id": "f6fe3795-1763-491a-ae22-82ff9008b38e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "sku_list" ], "variable": [ { "id": "4e21dd5f-4419-4506-8ec5-5f1dfb586b68", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the free gift promotion" }, "response": [ { "id": "6bfc0942-1e26-4258-acc1-7015b03587c7", "name": "The sku_list associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "sku_list" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6bfc0942-1e26-4258-acc1-7015b03587c7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f6fe3795-1763-491a-ae22-82ff9008b38e" } ], "id": "8245be05-4d2a-4b14-ac47-20c9b50ca17d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8245be05-4d2a-4b14-ac47-20c9b50ca17d" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the free gift promotion", "id": "214c364a-99a5-44ca-a03b-1caf293d8356", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "coupons" ], "variable": [ { "id": "180dd882-2a62-4269-85e8-3bfe121d3a20", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the free gift promotion" }, "response": [ { "id": "1f9db545-aa16-4372-9b97-853a85a87c3b", "name": "The coupons associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "coupons" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1f9db545-aa16-4372-9b97-853a85a87c3b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-214c364a-99a5-44ca-a03b-1caf293d8356" } ], "id": "3914108e-13ee-4b51-86b8-6801dc2d69f7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3914108e-13ee-4b51-86b8-6801dc2d69f7" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the free gift promotion", "id": "cf46f8cd-5957-4cc1-b394-d100895ea8ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "attachments" ], "variable": [ { "id": "bc2f55cf-31f0-453d-bbca-f093ce89b05c", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the free gift promotion" }, "response": [ { "id": "02a2ef0d-98d7-4a37-aef1-6c4930b182a6", "name": "The attachments associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "attachments" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-02a2ef0d-98d7-4a37-aef1-6c4930b182a6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cf46f8cd-5957-4cc1-b394-d100895ea8ba" } ], "id": "c202aa5c-789b-49e2-81da-8e4b96acc1a5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c202aa5c-789b-49e2-81da-8e4b96acc1a5" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the free gift promotion", "id": "f780226c-b2a7-476b-aad2-001f990f5ca3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "events" ], "variable": [ { "id": "4e823cb6-a32b-4d65-8f4b-6ad005d726a4", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the free gift promotion" }, "response": [ { "id": "246bea45-c06b-4c55-b55f-84269cca6711", "name": "The events associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "events" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-246bea45-c06b-4c55-b55f-84269cca6711" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f780226c-b2a7-476b-aad2-001f990f5ca3" } ], "id": "253a637e-fc49-4d60-9e87-8a076cd78613", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-253a637e-fc49-4d60-9e87-8a076cd78613" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the free gift promotion", "id": "42cbf572-59ca-460a-b60d-e0dc29e82c93", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "tags" ], "variable": [ { "id": "b5619241-a84f-48ab-898f-ca81ca8cd600", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the free gift promotion" }, "response": [ { "id": "4f2ab906-df34-49ea-b026-20f75b114e90", "name": "The tags associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "tags" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4f2ab906-df34-49ea-b026-20f75b114e90" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-42cbf572-59ca-460a-b60d-e0dc29e82c93" } ], "id": "078d908c-a9e3-4f51-9931-7f6f166d974a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-078d908c-a9e3-4f51-9931-7f6f166d974a" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the free gift promotion", "id": "edceaaca-5c09-4b4f-a96c-320e4cd0d9bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "event_stores" ], "variable": [ { "id": "72385974-0f1e-4853-8b3e-d170c25a61cf", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the free gift promotion" }, "response": [ { "id": "fd8ac59b-813a-41ab-8ce8-635c4d0cd91b", "name": "The event_stores associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "event_stores" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fd8ac59b-813a-41ab-8ce8-635c4d0cd91b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-edceaaca-5c09-4b4f-a96c-320e4cd0d9bd" } ], "id": "8b06921f-504b-44f8-94b7-187646b1e8eb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8b06921f-504b-44f8-94b7-187646b1e8eb" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the free gift promotion", "id": "4cb41bc8-2288-49d2-9987-0b0483c3c41a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "skus" ], "variable": [ { "id": "e9cfa328-b520-46bc-967d-7d68c74871b8", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the free gift promotion" }, "response": [ { "id": "16bfdc60-5b7b-4ff4-a1ca-debf4cd10f33", "name": "The skus associated to the free gift promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId", "skus" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-16bfdc60-5b7b-4ff4-a1ca-debf4cd10f33" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4cb41bc8-2288-49d2-9987-0b0483c3c41a" } ], "id": "d1692d12-e765-4c38-9974-5a3f75d4dd4e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d1692d12-e765-4c38-9974-5a3f75d4dd4e" }, { "name": "Retrieve a free gift promotion", "id": "051aafc9-aa9a-4ee9-9470-dcdb3c4f9171", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId" ], "variable": [ { "id": "9ed11ced-145d-47b8-94cc-083af70bfc25", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a free gift promotion" }, "response": [ { "id": "9aabecef-bb24-4cc4-ba80-a27c79a0b1ad", "name": "The free gift promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"free_gift_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9aabecef-bb24-4cc4-ba80-a27c79a0b1ad" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-051aafc9-aa9a-4ee9-9470-dcdb3c4f9171" }, { "name": "Update a free gift promotion", "id": "18ea3ade-4b86-4d0e-98d0-a31010319ebe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_gift_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId" ], "variable": [ { "id": "e3ee21f0-c50a-42d2-9b6e-a08a802e3cde", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a free gift promotion" }, "response": [ { "id": "e8b49d14-ad5c-4189-abea-888035b31b6f", "name": "The updated free gift promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_gift_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"free_gift_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e8b49d14-ad5c-4189-abea-888035b31b6f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-18ea3ade-4b86-4d0e-98d0-a31010319ebe" }, { "name": "Delete a free gift promotion", "id": "72654c0a-ed41-4f58-83f3-90c56ecba526", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId" ], "variable": [ { "id": "a9bf4472-1e4e-49be-9244-60575f589fe9", "key": "freeGiftPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a free gift promotion" }, "response": [ { "id": "064b74f1-b9f5-439a-9804-b65bf8692a8e", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions/:freeGiftPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions", ":freeGiftPromotionId" ], "variable": [ { "key": "freeGiftPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-064b74f1-b9f5-439a-9804-b65bf8692a8e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-72654c0a-ed41-4f58-83f3-90c56ecba526" } ], "id": "1e54eac2-6f64-4105-9885-81ca2a39d04e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1e54eac2-6f64-4105-9885-81ca2a39d04e" }, { "name": "List all free gift promotions", "id": "89937a8e-c867-4f1e-8672-71d25f8dd973", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions" ] }, "description": "List all free gift promotions" }, "response": [ { "id": "90718855-a339-4ed9-8b8b-4ba1c74351a0", "name": "A list of free gift promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_gift_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"free_gift_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"external_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"free_gift_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-90718855-a339-4ed9-8b8b-4ba1c74351a0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-89937a8e-c867-4f1e-8672-71d25f8dd973" }, { "name": "Create a free gift promotion", "id": "a8d48ffd-cca6-492f-911a-5304ecb58e59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_gift_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_gift_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions" ] }, "description": "Create a free gift promotion" }, "response": [ { "id": "87a34006-d391-4b07-9f86-df21de1970fc", "name": "The created free gift promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_gift_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_gift_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_gift_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"free_gift_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"max_quantity\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-87a34006-d391-4b07-9f86-df21de1970fc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8d48ffd-cca6-492f-911a-5304ecb58e59" } ], "id": "c0db0d69-9a7d-4296-a5ad-1fcb364f9beb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c0db0d69-9a7d-4296-a5ad-1fcb364f9beb" }, { "name": "free_shipping_promotions", "item": [ { "name": "{freeShippingPromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the free shipping promotion", "id": "d44214f8-7cb1-476b-a848-eb70e5e295dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "market" ], "variable": [ { "id": "6d1819f1-f318-48d7-abb3-83656bfe974a", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the free shipping promotion" }, "response": [ { "id": "08a435b8-0cfb-4049-8aaf-78115bc67d12", "name": "The market associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "market" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-08a435b8-0cfb-4049-8aaf-78115bc67d12" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d44214f8-7cb1-476b-a848-eb70e5e295dc" } ], "id": "5bb44ee0-c09b-461e-8262-bc9a5f301645", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5bb44ee0-c09b-461e-8262-bc9a5f301645" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the free shipping promotion", "id": "3be8ba23-7216-4554-8875-a4f8d5c6a538", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "3f6a1e05-aa51-450d-abf9-3189a2700ffe", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the free shipping promotion" }, "response": [ { "id": "ff414603-6d7f-41e9-8111-43cbefe9df8a", "name": "The order_amount_promotion_rule associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ff414603-6d7f-41e9-8111-43cbefe9df8a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3be8ba23-7216-4554-8875-a4f8d5c6a538" } ], "id": "9692fef3-9bea-4a1b-bcbf-e6447394ae1c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9692fef3-9bea-4a1b-bcbf-e6447394ae1c" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the free shipping promotion", "id": "41a8a9d7-7929-4ea4-adb7-49b03e0dc0bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "09f43ca1-63a8-4e61-b8ff-8ee2ed9eb441", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the free shipping promotion" }, "response": [ { "id": "3cb1edb6-36d7-4562-a860-bd700c3e6059", "name": "The sku_list_promotion_rule associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3cb1edb6-36d7-4562-a860-bd700c3e6059" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-41a8a9d7-7929-4ea4-adb7-49b03e0dc0bb" } ], "id": "24919d8d-841e-470f-809c-294af8449a31", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-24919d8d-841e-470f-809c-294af8449a31" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the free shipping promotion", "id": "71b86a8a-4c65-4f9d-bf64-3a07bc7b5ad8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "bc7cd0c2-1796-4c46-82d7-72185883beed", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the free shipping promotion" }, "response": [ { "id": "89ee1590-1181-4dbb-8df5-07613ca16512", "name": "The coupon_codes_promotion_rule associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-89ee1590-1181-4dbb-8df5-07613ca16512" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-71b86a8a-4c65-4f9d-bf64-3a07bc7b5ad8" } ], "id": "c818f826-ad11-449b-a611-46ee3282cefa", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c818f826-ad11-449b-a611-46ee3282cefa" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the free shipping promotion", "id": "074bd25b-fdc4-43ff-aba8-b596dea80b42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "custom_promotion_rule" ], "variable": [ { "id": "91ac4117-9b6b-4a27-bff0-97233a8ee6ee", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the free shipping promotion" }, "response": [ { "id": "67497c27-fe4b-486c-b300-e8767d0862ab", "name": "The custom_promotion_rule associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "custom_promotion_rule" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-67497c27-fe4b-486c-b300-e8767d0862ab" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-074bd25b-fdc4-43ff-aba8-b596dea80b42" } ], "id": "da4ff208-b3f9-4390-be6b-bd45c22fdcb2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-da4ff208-b3f9-4390-be6b-bd45c22fdcb2" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the free shipping promotion", "id": "7935077f-b82c-462a-bc24-755c26c212aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "sku_list" ], "variable": [ { "id": "f4a2d3f0-6700-4d64-8211-295c1b34cb35", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the free shipping promotion" }, "response": [ { "id": "90b1c011-8374-465d-bc18-1122e2e04889", "name": "The sku_list associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "sku_list" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-90b1c011-8374-465d-bc18-1122e2e04889" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7935077f-b82c-462a-bc24-755c26c212aa" } ], "id": "6d1bb018-e98a-4594-bf4e-6febb7d49b36", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6d1bb018-e98a-4594-bf4e-6febb7d49b36" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the free shipping promotion", "id": "027bb668-82ee-49f8-a1c7-995c3f0b5be3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "coupons" ], "variable": [ { "id": "be8af89e-4b72-46da-8e2a-330157d427dc", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the free shipping promotion" }, "response": [ { "id": "a9610bb0-b1c7-4fbd-bd10-88174bb34b47", "name": "The coupons associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "coupons" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a9610bb0-b1c7-4fbd-bd10-88174bb34b47" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-027bb668-82ee-49f8-a1c7-995c3f0b5be3" } ], "id": "ae7e3827-1636-4d62-a41b-6326c0792d8c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ae7e3827-1636-4d62-a41b-6326c0792d8c" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the free shipping promotion", "id": "0665643e-e34e-433e-8612-011b3e1e21e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "attachments" ], "variable": [ { "id": "86cb3d09-59c1-410b-9cda-cdc1fec5f7e1", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the free shipping promotion" }, "response": [ { "id": "50628f7c-6855-4886-be54-ea8a9aedd2f7", "name": "The attachments associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "attachments" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-50628f7c-6855-4886-be54-ea8a9aedd2f7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0665643e-e34e-433e-8612-011b3e1e21e6" } ], "id": "7fabba06-5156-40f8-8e56-497d0698b060", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7fabba06-5156-40f8-8e56-497d0698b060" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the free shipping promotion", "id": "94ee14a1-10c0-4f60-8531-2cfab42fa1f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "events" ], "variable": [ { "id": "a63be5f5-c3bf-4303-b99c-9986b9bcb247", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the free shipping promotion" }, "response": [ { "id": "690ee722-c263-4c38-9fb8-4b5b1eecd900", "name": "The events associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "events" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-690ee722-c263-4c38-9fb8-4b5b1eecd900" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-94ee14a1-10c0-4f60-8531-2cfab42fa1f2" } ], "id": "88fb499c-7e0f-440a-a1fd-a7aa00f6e82e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-88fb499c-7e0f-440a-a1fd-a7aa00f6e82e" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the free shipping promotion", "id": "01b1d9bb-04f9-4f1d-a917-234390160704", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "tags" ], "variable": [ { "id": "69dcf3f0-b99e-40e0-a07c-fddc413389e1", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the free shipping promotion" }, "response": [ { "id": "057023ed-41e0-4040-9557-90a11038799c", "name": "The tags associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "tags" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-057023ed-41e0-4040-9557-90a11038799c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-01b1d9bb-04f9-4f1d-a917-234390160704" } ], "id": "bcb1932a-170d-4d75-9829-da44e8af0a26", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bcb1932a-170d-4d75-9829-da44e8af0a26" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the free shipping promotion", "id": "ebbab815-de56-45ab-a543-ab9de94c67f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "event_stores" ], "variable": [ { "id": "40791fcd-8b90-4cac-91e1-b79febb1a584", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the free shipping promotion" }, "response": [ { "id": "194aa35e-7dc5-4da4-b0fd-46968296a580", "name": "The event_stores associated to the free shipping promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId", "event_stores" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-194aa35e-7dc5-4da4-b0fd-46968296a580" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ebbab815-de56-45ab-a543-ab9de94c67f3" } ], "id": "59f19cce-dbd4-4e85-ad72-62bff4cee0a8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-59f19cce-dbd4-4e85-ad72-62bff4cee0a8" }, { "name": "Retrieve a free shipping promotion", "id": "6c223225-6253-4162-b6df-c1bbcae6c3dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId" ], "variable": [ { "id": "bea9b228-4fef-4268-a389-93405b1ffef8", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a free shipping promotion" }, "response": [ { "id": "44ae02e6-8079-430f-bfed-60a4c28baef5", "name": "The free shipping promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-44ae02e6-8079-430f-bfed-60a4c28baef5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6c223225-6253-4162-b6df-c1bbcae6c3dd" }, { "name": "Update a free shipping promotion", "id": "99d66af9-fbc1-4974-bb64-4b523f59053b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_shipping_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId" ], "variable": [ { "id": "4589cff4-fece-4ce3-acb8-a0d744a2e4c6", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a free shipping promotion" }, "response": [ { "id": "730d7c75-6ae9-4156-b1e8-0268af79aef8", "name": "The updated free shipping promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_shipping_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-730d7c75-6ae9-4156-b1e8-0268af79aef8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-99d66af9-fbc1-4974-bb64-4b523f59053b" }, { "name": "Delete a free shipping promotion", "id": "cea3328e-3b0a-4f8c-ade4-87394972c5ae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId" ], "variable": [ { "id": "65596dac-8b1e-4a96-b0fe-d85b3cc355d6", "key": "freeShippingPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a free shipping promotion" }, "response": [ { "id": "2134342e-b15f-41b2-8a79-53c80d3f64e3", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions/:freeShippingPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions", ":freeShippingPromotionId" ], "variable": [ { "key": "freeShippingPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2134342e-b15f-41b2-8a79-53c80d3f64e3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cea3328e-3b0a-4f8c-ade4-87394972c5ae" } ], "id": "1ca45614-ce7e-411d-a1c4-2cec5364a5f1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1ca45614-ce7e-411d-a1c4-2cec5364a5f1" }, { "name": "List all free shipping promotions", "id": "8596b8fa-368c-482e-a910-51c9966167ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions" ] }, "description": "List all free shipping promotions" }, "response": [ { "id": "2aaf8afe-ef3c-4e93-a868-a99f79b0d0bb", "name": "A list of free shipping promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/free_shipping_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"buy_x_pay_y_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"external_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2aaf8afe-ef3c-4e93-a868-a99f79b0d0bb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8596b8fa-368c-482e-a910-51c9966167ce" }, { "name": "Create a free shipping promotion", "id": "ebd16aa3-3812-49dd-91c9-4110caadf5b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_shipping_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_shipping_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions" ] }, "description": "Create a free shipping promotion" }, "response": [ { "id": "dbbc3640-ed5e-419c-8cd9-34d87ab7237a", "name": "The created free shipping promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"free_shipping_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/free_shipping_promotions", "host": [ "{{baseUrl}}" ], "path": [ "free_shipping_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dbbc3640-ed5e-419c-8cd9-34d87ab7237a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ebd16aa3-3812-49dd-91c9-4110caadf5b2" } ], "id": "6d2ec2b3-3691-47b5-af44-b2d3cdda67bb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6d2ec2b3-3691-47b5-af44-b2d3cdda67bb" }, { "name": "geocoders", "item": [ { "name": "{geocoderId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the geocoder", "id": "ee08eaf6-f162-4a47-9629-f0f61c1893d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/markets", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "markets" ], "variable": [ { "id": "7135b86a-9802-4ccc-9d25-e4a78f8011ea", "key": "geocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the geocoder" }, "response": [ { "id": "2ac699e2-7d01-4baf-af11-cd9399a525b3", "name": "The markets associated to the geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/markets", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "markets" ], "variable": [ { "key": "geocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2ac699e2-7d01-4baf-af11-cd9399a525b3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ee08eaf6-f162-4a47-9629-f0f61c1893d2" } ], "id": "31462902-0545-451d-a469-e8b6c10893cf", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-31462902-0545-451d-a469-e8b6c10893cf" }, { "name": "addresses", "item": [ { "name": "Retrieve the addresses associated to the geocoder", "id": "91d6b5ff-1336-43f6-bad4-cb8a4fe22585", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "addresses" ], "variable": [ { "id": "9f42b6be-8b97-456b-95e2-7ac9324ac2d1", "key": "geocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the addresses associated to the geocoder" }, "response": [ { "id": "cd3d25fc-ce5a-4825-be88-3af56ec91608", "name": "The addresses associated to the geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "addresses" ], "variable": [ { "key": "geocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd3d25fc-ce5a-4825-be88-3af56ec91608" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-91d6b5ff-1336-43f6-bad4-cb8a4fe22585" } ], "id": "e5be15bd-c623-4500-8e5e-9bfe0403db3a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e5be15bd-c623-4500-8e5e-9bfe0403db3a" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the geocoder", "id": "f3a20573-0bb7-4c56-8044-6c3a85be19f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "attachments" ], "variable": [ { "id": "c575a6b5-b3b5-4c7b-9282-869ca23228c1", "key": "geocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the geocoder" }, "response": [ { "id": "b1dc83b5-13ca-4435-b8cb-11877a24645d", "name": "The attachments associated to the geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "attachments" ], "variable": [ { "key": "geocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b1dc83b5-13ca-4435-b8cb-11877a24645d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f3a20573-0bb7-4c56-8044-6c3a85be19f0" } ], "id": "1af59860-8171-4f55-bf10-6b128cc4b2ae", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1af59860-8171-4f55-bf10-6b128cc4b2ae" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the geocoder", "id": "92889f44-fbb4-4d9d-8897-b38500307efa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "event_stores" ], "variable": [ { "id": "5fab203b-cc4c-472e-b516-5a3563d7664e", "key": "geocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the geocoder" }, "response": [ { "id": "c8a8675f-f332-4acc-be14-0e1457a7b0af", "name": "The event_stores associated to the geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId", "event_stores" ], "variable": [ { "key": "geocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c8a8675f-f332-4acc-be14-0e1457a7b0af" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-92889f44-fbb4-4d9d-8897-b38500307efa" } ], "id": "8a1fa1d8-21db-40c1-9bcc-8e2119f29385", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8a1fa1d8-21db-40c1-9bcc-8e2119f29385" }, { "name": "Retrieve a geocoder", "id": "4024cf7a-a92a-4d1d-bcb6-3e29003e958b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId" ], "variable": [ { "id": "9a5a7591-a050-4b3d-b00e-f5f7a290eb3a", "key": "geocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a geocoder" }, "response": [ { "id": "fb1edd38-bf18-4f8b-afc5-7dc4d541f399", "name": "The geocoder object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/geocoders/:geocoderId", "host": [ "{{baseUrl}}" ], "path": [ "geocoders", ":geocoderId" ], "variable": [ { "key": "geocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fb1edd38-bf18-4f8b-afc5-7dc4d541f399" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4024cf7a-a92a-4d1d-bcb6-3e29003e958b" } ], "id": "363ee4ae-c26d-4027-bc60-66253aa08905", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-363ee4ae-c26d-4027-bc60-66253aa08905" }, { "name": "List all geocoders", "id": "8cad648d-05f0-4723-8a7f-189dcd22d19a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/geocoders", "host": [ "{{baseUrl}}" ], "path": [ "geocoders" ] }, "description": "List all geocoders" }, "response": [ { "id": "a2bc87cf-ddd1-49e6-98b8-3a18d310b6a1", "name": "A list of geocoder objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/geocoders", "host": [ "{{baseUrl}}" ], "path": [ "geocoders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"bing_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a2bc87cf-ddd1-49e6-98b8-3a18d310b6a1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8cad648d-05f0-4723-8a7f-189dcd22d19a" } ], "id": "4e00e418-b9ba-463d-9035-e742179f52c4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4e00e418-b9ba-463d-9035-e742179f52c4" }, { "name": "gift_card_recipients", "item": [ { "name": "{giftCardRecipientId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the gift card recipient", "id": "3522abcb-513c-49b4-9161-1ddf68bdaaf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId/customer", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId", "customer" ], "variable": [ { "id": "2786d15d-d09f-4fd9-bd4c-7f620305e4f2", "key": "giftCardRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the gift card recipient" }, "response": [ { "id": "b3ea856a-571c-45f1-aed3-00508669767d", "name": "The customer associated to the gift card recipient", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId/customer", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId", "customer" ], "variable": [ { "key": "giftCardRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b3ea856a-571c-45f1-aed3-00508669767d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3522abcb-513c-49b4-9161-1ddf68bdaaf7" } ], "id": "83372e8c-30b4-488a-bf71-c78dbc66184c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-83372e8c-30b4-488a-bf71-c78dbc66184c" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the gift card recipient", "id": "1ee4ee29-e7c1-43ff-8fa6-dadd4dc6f44a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId", "event_stores" ], "variable": [ { "id": "02bd9de6-563a-4a64-acdc-5828f4485418", "key": "giftCardRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the gift card recipient" }, "response": [ { "id": "481316fb-01ae-4038-9691-184eafce84ef", "name": "The event_stores associated to the gift card recipient", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId", "event_stores" ], "variable": [ { "key": "giftCardRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-481316fb-01ae-4038-9691-184eafce84ef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ee4ee29-e7c1-43ff-8fa6-dadd4dc6f44a" } ], "id": "5736786d-d8ac-4547-b15c-d7984a7c4f25", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5736786d-d8ac-4547-b15c-d7984a7c4f25" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the gift card recipient", "id": "c3d0e3be-8aab-4463-a173-cf926409a195", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId", "attachments" ], "variable": [ { "id": "40d3299f-8be6-43ec-9e4a-a15b7659fea7", "key": "giftCardRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the gift card recipient" }, "response": [ { "id": "dc86bb6b-19e8-453e-a4c0-aad9408ffa2a", "name": "The attachments associated to the gift card recipient", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId", "attachments" ], "variable": [ { "key": "giftCardRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dc86bb6b-19e8-453e-a4c0-aad9408ffa2a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c3d0e3be-8aab-4463-a173-cf926409a195" } ], "id": "d0aec7b3-c1a9-4a00-8392-abad47365a88", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d0aec7b3-c1a9-4a00-8392-abad47365a88" }, { "name": "Retrieve a gift card recipient", "id": "a659c94d-bfdc-49ed-9001-aa8c9c2ef6f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId" ], "variable": [ { "id": "7c6b7e01-238b-4c6c-a060-7204b8dd5e0f", "key": "giftCardRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a gift card recipient" }, "response": [ { "id": "24d7f3a4-87b3-4cfe-a8f6-5a45324bb0f2", "name": "The gift card recipient object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId" ], "variable": [ { "key": "giftCardRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"gift_card_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-24d7f3a4-87b3-4cfe-a8f6-5a45324bb0f2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a659c94d-bfdc-49ed-9001-aa8c9c2ef6f8" }, { "name": "Update a gift card recipient", "id": "7ebe7a15-93d2-4d70-9d04-ddcff8a65f13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"id\": \"\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId" ], "variable": [ { "id": "6795e967-944d-4b66-be9c-2d5a4d1a120e", "key": "giftCardRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a gift card recipient" }, "response": [ { "id": "90829b15-9fca-45a0-a378-6d746ecf19be", "name": "The updated gift card recipient object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"id\": \"\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId" ], "variable": [ { "key": "giftCardRecipientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"gift_card_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-90829b15-9fca-45a0-a378-6d746ecf19be" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7ebe7a15-93d2-4d70-9d04-ddcff8a65f13" }, { "name": "Delete a gift card recipient", "id": "4aeb24c6-ba68-44c8-86dc-6031dc27e8a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId" ], "variable": [ { "id": "d6e41935-d146-4cb7-a833-5c76523610ae", "key": "giftCardRecipientId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a gift card recipient" }, "response": [ { "id": "1e021b6b-dd04-4b42-ab8a-a1138e4a9620", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients/:giftCardRecipientId", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients", ":giftCardRecipientId" ], "variable": [ { "key": "giftCardRecipientId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1e021b6b-dd04-4b42-ab8a-a1138e4a9620" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4aeb24c6-ba68-44c8-86dc-6031dc27e8a1" } ], "id": "e477a684-9ff6-4c74-82dd-ee61f980a7c9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e477a684-9ff6-4c74-82dd-ee61f980a7c9" }, { "name": "List all gift card recipients", "id": "545d67d8-bb79-4a8f-b8ac-6699f9b54c00", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients" ] }, "description": "List all gift card recipients" }, "response": [ { "id": "9ae7f478-5b2d-480a-a6a9-606bafc9934c", "name": "A list of gift card recipient objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_card_recipients", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"gift_card_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"gift_card_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9ae7f478-5b2d-480a-a6a9-606bafc9934c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-545d67d8-bb79-4a8f-b8ac-6699f9b54c00" }, { "name": "Create a gift card recipient", "id": "d54debf1-173e-4edf-86de-9f2f7743228e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_card_recipients", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients" ] }, "description": "Create a gift card recipient" }, "response": [ { "id": "ee65c202-6c68-4642-82d9-8f2728228c9f", "name": "The created gift card recipient object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_card_recipients", "host": [ "{{baseUrl}}" ], "path": [ "gift_card_recipients" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"gift_card_recipients\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ee65c202-6c68-4642-82d9-8f2728228c9f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d54debf1-173e-4edf-86de-9f2f7743228e" } ], "id": "b4e0209e-d162-4d8f-b858-d1d5779b03c7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b4e0209e-d162-4d8f-b858-d1d5779b03c7" }, { "name": "gift_cards", "item": [ { "name": "{giftCardId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the gift card", "id": "83d7cb4a-6391-4510-b893-4b75795339f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/market", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "market" ], "variable": [ { "id": "d05e1a7e-25c3-4153-996c-695a48fab5b0", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the gift card" }, "response": [ { "id": "e31578f9-28b1-4921-aebf-45c2e04cf4bd", "name": "The market associated to the gift card", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/market", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "market" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e31578f9-28b1-4921-aebf-45c2e04cf4bd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83d7cb4a-6391-4510-b893-4b75795339f2" } ], "id": "f2a6fb1e-06f4-4f10-8b0e-66fa4ac3b40d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f2a6fb1e-06f4-4f10-8b0e-66fa4ac3b40d" }, { "name": "gift_card_recipient", "item": [ { "name": "Retrieve the gift card recipient associated to the gift card", "id": "dadb5afb-393b-4ebd-9b20-61c40152cd05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/gift_card_recipient", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "gift_card_recipient" ], "variable": [ { "id": "c52fe5d1-e570-4ed5-8506-a2ddcfe3fc77", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the gift card recipient associated to the gift card" }, "response": [ { "id": "e58c49df-9571-4ff5-b7d0-d6c69505fdd6", "name": "The gift_card_recipient associated to the gift card", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/gift_card_recipient", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "gift_card_recipient" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e58c49df-9571-4ff5-b7d0-d6c69505fdd6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dadb5afb-393b-4ebd-9b20-61c40152cd05" } ], "id": "8fbdc2a3-1cc9-4c21-b645-4d9cd87f5ca5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8fbdc2a3-1cc9-4c21-b645-4d9cd87f5ca5" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the gift card", "id": "a606469d-0246-46c5-8ae2-c640e77ab9fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "attachments" ], "variable": [ { "id": "0721d5c1-00a7-4b69-82cb-e28f9d233025", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the gift card" }, "response": [ { "id": "183ae844-d59c-44ce-a4ec-306a501f4d80", "name": "The attachments associated to the gift card", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "attachments" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-183ae844-d59c-44ce-a4ec-306a501f4d80" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a606469d-0246-46c5-8ae2-c640e77ab9fd" } ], "id": "903e933a-6876-4633-850c-20b419ee4e2f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-903e933a-6876-4633-850c-20b419ee4e2f" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the gift card", "id": "499647db-7950-45ea-b464-5cb37b87af6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/events", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "events" ], "variable": [ { "id": "0211e0a0-5e49-407a-9429-7fdc9e523311", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the gift card" }, "response": [ { "id": "73929bc3-774a-4934-b980-53ec284d0e4f", "name": "The events associated to the gift card", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/events", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "events" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-73929bc3-774a-4934-b980-53ec284d0e4f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-499647db-7950-45ea-b464-5cb37b87af6e" } ], "id": "4ccf59d1-37de-4577-8def-a6aec0791c24", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4ccf59d1-37de-4577-8def-a6aec0791c24" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the gift card", "id": "c8757731-147b-4424-a2fb-bda33fab1035", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/tags", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "tags" ], "variable": [ { "id": "d1798de9-1b29-45d8-bb7c-561e1d8c1291", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the gift card" }, "response": [ { "id": "cf372ec4-981f-411d-bd8a-8113212ca89f", "name": "The tags associated to the gift card", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/tags", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "tags" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cf372ec4-981f-411d-bd8a-8113212ca89f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c8757731-147b-4424-a2fb-bda33fab1035" } ], "id": "b81b68eb-4046-4f2c-8dbc-a54d66884494", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b81b68eb-4046-4f2c-8dbc-a54d66884494" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the gift card", "id": "4b88afb5-70be-4289-9a5c-fcc2f5c41332", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "event_stores" ], "variable": [ { "id": "fb0d4256-79d7-484f-9d18-3d48295e6dcf", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the gift card" }, "response": [ { "id": "f896dddf-958a-4b6e-a279-9fc00414bff1", "name": "The event_stores associated to the gift card", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId", "event_stores" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f896dddf-958a-4b6e-a279-9fc00414bff1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4b88afb5-70be-4289-9a5c-fcc2f5c41332" } ], "id": "c0daaaac-27d6-4ff9-8c4a-47f75fc95d95", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c0daaaac-27d6-4ff9-8c4a-47f75fc95d95" }, { "name": "Retrieve a gift card", "id": "88506757-53ae-4548-8bc0-a8d8eb6f7e26", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId" ], "variable": [ { "id": "c6012752-0dda-440c-ba53-5aa0a4b5eacc", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a gift card" }, "response": [ { "id": "412bc861-b7c4-4c82-8e84-77f568f0f5cf", "name": "The gift card object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"gift_cards\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"active\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"initial_balance_cents\": \"\",\n \"initial_balance_float\": \"\",\n \"formatted_initial_balance\": \"\",\n \"balance_cents\": \"\",\n \"balance_float\": \"\",\n \"formatted_balance\": \"\",\n \"balance_max_cents\": \"\",\n \"balance_max_float\": \"\",\n \"formatted_balance_max\": \"\",\n \"usage_log\": {},\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card_recipient\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-412bc861-b7c4-4c82-8e84-77f568f0f5cf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-88506757-53ae-4548-8bc0-a8d8eb6f7e26" }, { "name": "Update a gift card", "id": "ad57f3d7-4713-4a07-8ed1-8df48d9be85b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_cards\",\n \"id\": \"\",\n \"attributes\": {\n \"currency_code\": \"\",\n \"balance_cents\": \"\",\n \"balance_max_cents\": \"\",\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"_purchase\": \"\",\n \"_activate\": \"\",\n \"_deactivate\": \"\",\n \"_balance_change_cents\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId" ], "variable": [ { "id": "018d20fb-8db1-4034-bf34-26b4ef755aad", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a gift card" }, "response": [ { "id": "6a34d611-01eb-457f-b789-53ef09b3823a", "name": "The updated gift card object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_cards\",\n \"id\": \"\",\n \"attributes\": {\n \"currency_code\": \"\",\n \"balance_cents\": \"\",\n \"balance_max_cents\": \"\",\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"_purchase\": \"\",\n \"_activate\": \"\",\n \"_deactivate\": \"\",\n \"_balance_change_cents\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"gift_cards\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"active\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"initial_balance_cents\": \"\",\n \"initial_balance_float\": \"\",\n \"formatted_initial_balance\": \"\",\n \"balance_cents\": \"\",\n \"balance_float\": \"\",\n \"formatted_balance\": \"\",\n \"balance_max_cents\": \"\",\n \"balance_max_float\": \"\",\n \"formatted_balance_max\": \"\",\n \"usage_log\": {},\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card_recipient\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6a34d611-01eb-457f-b789-53ef09b3823a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad57f3d7-4713-4a07-8ed1-8df48d9be85b" }, { "name": "Delete a gift card", "id": "13f93a48-5a41-458d-b75f-b00e59104b9f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId" ], "variable": [ { "id": "15c8e094-9e69-4c8f-bd22-f27b5683a266", "key": "giftCardId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a gift card" }, "response": [ { "id": "8c4cda56-4818-4925-9013-1a00cad91243", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards/:giftCardId", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards", ":giftCardId" ], "variable": [ { "key": "giftCardId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8c4cda56-4818-4925-9013-1a00cad91243" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-13f93a48-5a41-458d-b75f-b00e59104b9f" } ], "id": "915ea15c-a521-4696-b550-0835e0a4a277", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-915ea15c-a521-4696-b550-0835e0a4a277" }, { "name": "List all gift cards", "id": "6ca99ae6-3420-4c90-82e1-d135c4f6a7c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/gift_cards", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards" ] }, "description": "List all gift cards" }, "response": [ { "id": "1ca4106e-c056-41fb-afb1-a5f77f81f6a6", "name": "A list of gift card objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/gift_cards", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"gift_cards\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"active\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"initial_balance_cents\": \"\",\n \"initial_balance_float\": \"\",\n \"formatted_initial_balance\": \"\",\n \"balance_cents\": \"\",\n \"balance_float\": \"\",\n \"formatted_balance\": \"\",\n \"balance_max_cents\": \"\",\n \"balance_max_float\": \"\",\n \"formatted_balance_max\": \"\",\n \"usage_log\": {},\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card_recipient\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"gift_cards\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"draft\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"initial_balance_cents\": \"\",\n \"initial_balance_float\": \"\",\n \"formatted_initial_balance\": \"\",\n \"balance_cents\": \"\",\n \"balance_float\": \"\",\n \"formatted_balance\": \"\",\n \"balance_max_cents\": \"\",\n \"balance_max_float\": \"\",\n \"formatted_balance_max\": \"\",\n \"usage_log\": {},\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card_recipient\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1ca4106e-c056-41fb-afb1-a5f77f81f6a6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6ca99ae6-3420-4c90-82e1-d135c4f6a7c0" }, { "name": "Create a gift card", "id": "ca99835c-4a70-4e36-adae-f939d80af444", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_cards\",\n \"attributes\": {\n \"balance_cents\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"balance_max_cents\": \"\",\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_cards", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards" ] }, "description": "Create a gift card" }, "response": [ { "id": "693ad59d-fe07-48f8-826c-48027d7477e3", "name": "The created gift card object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"gift_cards\",\n \"attributes\": {\n \"balance_cents\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"balance_max_cents\": \"\",\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"data\": {\n \"type\": \"gift_card_recipients\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/gift_cards", "host": [ "{{baseUrl}}" ], "path": [ "gift_cards" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"gift_cards\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"active\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"initial_balance_cents\": \"\",\n \"initial_balance_float\": \"\",\n \"formatted_initial_balance\": \"\",\n \"balance_cents\": \"\",\n \"balance_float\": \"\",\n \"formatted_balance\": \"\",\n \"balance_max_cents\": \"\",\n \"balance_max_float\": \"\",\n \"formatted_balance_max\": \"\",\n \"usage_log\": {},\n \"single_use\": \"\",\n \"rechargeable\": \"\",\n \"distribute_discount\": \"\",\n \"image_url\": \"\",\n \"expires_at\": \"\",\n \"recipient_email\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"gift_card_recipient\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card_recipient\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-693ad59d-fe07-48f8-826c-48027d7477e3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ca99835c-4a70-4e36-adae-f939d80af444" } ], "id": "9eb9abb6-6405-497a-9abc-0687f5911d80", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9eb9abb6-6405-497a-9abc-0687f5911d80" }, { "name": "google_geocoders", "item": [ { "name": "{googleGeocoderId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the google geocoder", "id": "83cc72ad-5296-4416-9a38-3477a3d8ad4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/markets", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "markets" ], "variable": [ { "id": "40bbdfa6-2e93-4a90-a517-682da1d8b8d4", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the google geocoder" }, "response": [ { "id": "5980e34f-3900-470f-8693-bc3ec9a6e4f1", "name": "The markets associated to the google geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/markets", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "markets" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5980e34f-3900-470f-8693-bc3ec9a6e4f1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83cc72ad-5296-4416-9a38-3477a3d8ad4b" } ], "id": "71757137-34c2-4c2c-9ade-e68c01d6efd9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-71757137-34c2-4c2c-9ade-e68c01d6efd9" }, { "name": "addresses", "item": [ { "name": "Retrieve the addresses associated to the google geocoder", "id": "7493f77c-3ad0-47a9-96e9-7d2a955b3538", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "addresses" ], "variable": [ { "id": "8121d91d-c538-4b33-aa3d-3637ec4d1b15", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the addresses associated to the google geocoder" }, "response": [ { "id": "062ba2dd-1763-4756-9e23-527e66939ee6", "name": "The addresses associated to the google geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/addresses", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "addresses" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-062ba2dd-1763-4756-9e23-527e66939ee6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7493f77c-3ad0-47a9-96e9-7d2a955b3538" } ], "id": "af5b1f89-d078-4692-bfec-44aeef98c586", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-af5b1f89-d078-4692-bfec-44aeef98c586" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the google geocoder", "id": "ea4a389f-96dd-46be-9efe-92b7fe0d3168", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "attachments" ], "variable": [ { "id": "51c278cc-f14a-4399-94a3-b4bcfd0f74f4", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the google geocoder" }, "response": [ { "id": "cd5271ea-7ba3-4044-bad9-95fe87f95db6", "name": "The attachments associated to the google geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "attachments" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd5271ea-7ba3-4044-bad9-95fe87f95db6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ea4a389f-96dd-46be-9efe-92b7fe0d3168" } ], "id": "a977ef8c-0d91-40a8-8b24-000d263866d8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a977ef8c-0d91-40a8-8b24-000d263866d8" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the google geocoder", "id": "a1db7232-5069-478f-bf37-c08c5cffcaad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "event_stores" ], "variable": [ { "id": "6d2d80fd-ea48-4261-943c-b30f54cfff41", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the google geocoder" }, "response": [ { "id": "cbdec5d2-93c9-4132-be02-b09a172a493b", "name": "The event_stores associated to the google geocoder", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId", "event_stores" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cbdec5d2-93c9-4132-be02-b09a172a493b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a1db7232-5069-478f-bf37-c08c5cffcaad" } ], "id": "08171fdd-0ec7-413e-bbc8-a946b85e7408", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-08171fdd-0ec7-413e-bbc8-a946b85e7408" }, { "name": "Retrieve a google geocoder", "id": "c3b77c94-1b0a-456f-b46f-ba85b5fe8a54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId" ], "variable": [ { "id": "8de46d94-3a9e-4629-aa2f-a8334d849053", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a google geocoder" }, "response": [ { "id": "49166e12-35c9-44d8-b0fd-0da99ebff507", "name": "The google geocoder object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"google_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-49166e12-35c9-44d8-b0fd-0da99ebff507" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c3b77c94-1b0a-456f-b46f-ba85b5fe8a54" }, { "name": "Update a google geocoder", "id": "7e188c26-24a9-4967-987e-cec2becbd59d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"google_geocoders\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId" ], "variable": [ { "id": "d1356973-0ef0-48e5-a74b-6b8292ffaacb", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a google geocoder" }, "response": [ { "id": "657ffb17-bacc-49a6-818a-240d514f6df3", "name": "The updated google geocoder object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"google_geocoders\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"google_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-657ffb17-bacc-49a6-818a-240d514f6df3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7e188c26-24a9-4967-987e-cec2becbd59d" }, { "name": "Delete a google geocoder", "id": "c82210c6-23bf-404c-a6e8-5ca59cf4693d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId" ], "variable": [ { "id": "1ba31556-c637-4221-9ba3-710ed2677969", "key": "googleGeocoderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a google geocoder" }, "response": [ { "id": "19274a28-4310-4de1-add9-307ab8463698", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders/:googleGeocoderId", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders", ":googleGeocoderId" ], "variable": [ { "key": "googleGeocoderId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-19274a28-4310-4de1-add9-307ab8463698" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c82210c6-23bf-404c-a6e8-5ca59cf4693d" } ], "id": "94656de6-1160-4eb2-8bca-9d70e6b74e93", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-94656de6-1160-4eb2-8bca-9d70e6b74e93" }, { "name": "List all google geocoders", "id": "10ad924a-0dd4-4880-a715-802071048d40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/google_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders" ] }, "description": "List all google geocoders" }, "response": [ { "id": "c26a9495-6504-40dc-9c02-27973cf2bab9", "name": "A list of google geocoder objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/google_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"google_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"google_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c26a9495-6504-40dc-9c02-27973cf2bab9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-10ad924a-0dd4-4880-a715-802071048d40" }, { "name": "Create a google geocoder", "id": "83b0b5cf-01d4-4c4b-8f3b-a4a97b527098", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"google_geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/google_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders" ] }, "description": "Create a google geocoder" }, "response": [ { "id": "535dc1c0-e40a-48a1-a093-79fc68d4a78d", "name": "The created google geocoder object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"google_geocoders\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/google_geocoders", "host": [ "{{baseUrl}}" ], "path": [ "google_geocoders" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"google_geocoders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"google_geocoders\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"addresses\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-535dc1c0-e40a-48a1-a093-79fc68d4a78d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83b0b5cf-01d4-4c4b-8f3b-a4a97b527098" } ], "id": "2caeb92a-f91a-4baf-932a-0bd62a50f973", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2caeb92a-f91a-4baf-932a-0bd62a50f973" }, { "name": "imports", "item": [ { "name": "{importId}", "item": [ { "name": "events", "item": [ { "name": "Retrieve the events associated to the import", "id": "f7b183d2-e05f-410a-ab41-8f3069ba294f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/imports/:importId/events", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId", "events" ], "variable": [ { "id": "036a72a6-1fba-425b-afc7-95d04220a207", "key": "importId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the import" }, "response": [ { "id": "33fcef0b-51d0-4851-bd0f-125c0a495ba0", "name": "The events associated to the import", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/imports/:importId/events", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId", "events" ], "variable": [ { "key": "importId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-33fcef0b-51d0-4851-bd0f-125c0a495ba0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f7b183d2-e05f-410a-ab41-8f3069ba294f" } ], "id": "35bacc28-65bd-4b52-8709-3299c961b249", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-35bacc28-65bd-4b52-8709-3299c961b249" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the import", "id": "dff7d873-28ad-4692-8223-baf317f7733a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/imports/:importId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId", "event_stores" ], "variable": [ { "id": "e82d94ec-a0a8-42ed-8db4-e769c7252077", "key": "importId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the import" }, "response": [ { "id": "793a74e5-bd2f-4d8e-a767-08272ba4c96c", "name": "The event_stores associated to the import", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/imports/:importId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId", "event_stores" ], "variable": [ { "key": "importId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-793a74e5-bd2f-4d8e-a767-08272ba4c96c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dff7d873-28ad-4692-8223-baf317f7733a" } ], "id": "b7964499-1f25-40a7-8394-21ec362a9927", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b7964499-1f25-40a7-8394-21ec362a9927" }, { "name": "Retrieve an import", "id": "5c68599e-feca-4e47-8a76-21e30df817a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/imports/:importId", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "variable": [ { "id": "14b2bd11-1d4d-4a6e-9230-721349ba4930", "key": "importId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an import" }, "response": [ { "id": "775959df-45fe-4bc2-9465-50db53af7efd", "name": "The import object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/imports/:importId", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "variable": [ { "key": "importId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"imports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"status\": \"pending\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"inputs_size\": \"\",\n \"errors_count\": \"\",\n \"warnings_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"warnings_log\": {},\n \"skip_errors\": \"\",\n \"attachment_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-775959df-45fe-4bc2-9465-50db53af7efd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5c68599e-feca-4e47-8a76-21e30df817a9" }, { "name": "Update an import", "id": "40010456-0146-4c81-8c82-4ef2b382aa49", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"imports\",\n \"id\": \"\",\n \"attributes\": {\n \"_interrupt\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/imports/:importId", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "variable": [ { "id": "642df6a6-3ff4-4ec7-ac2b-4805e985646d", "key": "importId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an import" }, "response": [ { "id": "86eb8321-1d26-4fbd-a744-17765313aa82", "name": "The updated import object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"imports\",\n \"id\": \"\",\n \"attributes\": {\n \"_interrupt\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/imports/:importId", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "variable": [ { "key": "importId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"imports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"status\": \"pending\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"inputs_size\": \"\",\n \"errors_count\": \"\",\n \"warnings_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"warnings_log\": {},\n \"skip_errors\": \"\",\n \"attachment_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-86eb8321-1d26-4fbd-a744-17765313aa82" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-40010456-0146-4c81-8c82-4ef2b382aa49" }, { "name": "Delete an import", "id": "201c1ac3-fb5e-4d4d-b709-50e13f559139", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/imports/:importId", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "variable": [ { "id": "725431e4-f506-4777-aae2-6969d1829284", "key": "importId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an import" }, "response": [ { "id": "18d05b84-01c2-4ea7-8205-630dddb3218e", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/imports/:importId", "host": [ "{{baseUrl}}" ], "path": [ "imports", ":importId" ], "variable": [ { "key": "importId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-18d05b84-01c2-4ea7-8205-630dddb3218e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-201c1ac3-fb5e-4d4d-b709-50e13f559139" } ], "id": "cb17b904-b318-4fdf-b339-195f84b4577f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cb17b904-b318-4fdf-b339-195f84b4577f" }, { "name": "List all imports", "id": "e18304f4-b2cd-45e1-9147-4d25ce8ed623", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ] }, "description": "List all imports" }, "response": [ { "id": "560c40c8-a5a7-4d6f-9433-35c3077d2d7f", "name": "A list of import objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"imports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"inputs_size\": \"\",\n \"errors_count\": \"\",\n \"warnings_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"warnings_log\": {},\n \"skip_errors\": \"\",\n \"attachment_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"imports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"status\": \"pending\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"inputs_size\": \"\",\n \"errors_count\": \"\",\n \"warnings_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"warnings_log\": {},\n \"skip_errors\": \"\",\n \"attachment_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-560c40c8-a5a7-4d6f-9433-35c3077d2d7f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e18304f4-b2cd-45e1-9147-4d25ce8ed623" }, { "name": "Create an import", "id": "485532bf-ff4d-4f8a-93c3-f8dce60e05c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"imports\",\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"skip_errors\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ] }, "description": "Create an import" }, "response": [ { "id": "4cc46780-df75-4686-9ec3-2a208601b4c2", "name": "The created import object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"imports\",\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"skip_errors\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/imports", "host": [ "{{baseUrl}}" ], "path": [ "imports" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"imports\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"format\": \"\",\n \"parent_resource_id\": \"\",\n \"status\": \"pending\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"interrupted_at\": \"\",\n \"inputs_size\": \"\",\n \"errors_count\": \"\",\n \"warnings_count\": \"\",\n \"processed_count\": \"\",\n \"errors_log\": {},\n \"warnings_log\": {},\n \"skip_errors\": \"\",\n \"attachment_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4cc46780-df75-4686-9ec3-2a208601b4c2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-485532bf-ff4d-4f8a-93c3-f8dce60e05c8" } ], "id": "7d0b40ac-3fad-478c-b882-43f98c82e8f9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7d0b40ac-3fad-478c-b882-43f98c82e8f9" }, { "name": "in_stock_subscriptions", "item": [ { "name": "{inStockSubscriptionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the in stock subscription", "id": "5a90d31a-9935-496e-a409-dce4c40d5464", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/market", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "market" ], "variable": [ { "id": "a4d89aea-b102-46d9-a88a-92f706419253", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the in stock subscription" }, "response": [ { "id": "42e407ce-7f3f-4dee-bc88-5d2838f757f2", "name": "The market associated to the in stock subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/market", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "market" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-42e407ce-7f3f-4dee-bc88-5d2838f757f2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5a90d31a-9935-496e-a409-dce4c40d5464" } ], "id": "648e2efa-b50c-4cd8-9ee2-688fb0781baf", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-648e2efa-b50c-4cd8-9ee2-688fb0781baf" }, { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the in stock subscription", "id": "43f5aed0-1c92-42cb-98aa-9e086d8e6d5e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/customer", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "customer" ], "variable": [ { "id": "b08c8a48-b634-4068-8bcc-8c1f9125e29a", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the in stock subscription" }, "response": [ { "id": "0aa18fa4-c22e-4f1c-a25b-ebecf9150728", "name": "The customer associated to the in stock subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/customer", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "customer" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0aa18fa4-c22e-4f1c-a25b-ebecf9150728" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-43f5aed0-1c92-42cb-98aa-9e086d8e6d5e" } ], "id": "a426ee80-35db-4199-b36a-3e386eb01ac2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a426ee80-35db-4199-b36a-3e386eb01ac2" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the in stock subscription", "id": "9cdc24fd-2a57-4eb8-bca8-b3483c7aa5e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/sku", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "sku" ], "variable": [ { "id": "7574f382-134b-45da-a850-b548629bd2d7", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the in stock subscription" }, "response": [ { "id": "47b5f46e-8051-4fc1-84be-5a385cb0ff09", "name": "The sku associated to the in stock subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/sku", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "sku" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-47b5f46e-8051-4fc1-84be-5a385cb0ff09" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9cdc24fd-2a57-4eb8-bca8-b3483c7aa5e5" } ], "id": "17d5c86e-dd35-4867-8499-4e2d7624c374", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-17d5c86e-dd35-4867-8499-4e2d7624c374" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the in stock subscription", "id": "f9066e2b-c2c2-43f7-928b-549ee2a1780d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "events" ], "variable": [ { "id": "914508ec-3fb3-42cb-a925-d9ab5259e234", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the in stock subscription" }, "response": [ { "id": "ef86ec49-f050-4af6-afe2-18695d487fec", "name": "The events associated to the in stock subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "events" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ef86ec49-f050-4af6-afe2-18695d487fec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f9066e2b-c2c2-43f7-928b-549ee2a1780d" } ], "id": "e69a14ae-1d96-4ebf-b40e-711c5b2efa79", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e69a14ae-1d96-4ebf-b40e-711c5b2efa79" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the in stock subscription", "id": "3657b33d-88e6-4752-9352-de1ee054da4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "event_stores" ], "variable": [ { "id": "21cc5910-afc0-4986-a863-3e38ad5aab9c", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the in stock subscription" }, "response": [ { "id": "d04384ca-7533-4523-aeb7-da57e353007f", "name": "The event_stores associated to the in stock subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId", "event_stores" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d04384ca-7533-4523-aeb7-da57e353007f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3657b33d-88e6-4752-9352-de1ee054da4c" } ], "id": "2d5ca7b4-d85f-4576-81b5-a927f55665f4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2d5ca7b4-d85f-4576-81b5-a927f55665f4" }, { "name": "Retrieve an in stock subscription", "id": "ae08de33-d38b-478a-972b-84915dd8d9d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId" ], "variable": [ { "id": "3f394c40-f95d-4210-bf59-c1566fdc3823", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an in stock subscription" }, "response": [ { "id": "11fb1cac-5e64-435d-b5c6-eb9f2cb94938", "name": "The in stock subscription object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"in_stock_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"inactive\",\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-11fb1cac-5e64-435d-b5c6-eb9f2cb94938" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ae08de33-d38b-478a-972b-84915dd8d9d1" }, { "name": "Update an in stock subscription", "id": "44c882cb-374c-40d4-8d77-7c69efd1ad08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"in_stock_subscriptions\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"_activate\": \"\",\n \"_deactivate\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId" ], "variable": [ { "id": "e766e78f-1711-4723-ade5-a19583b0beb0", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an in stock subscription" }, "response": [ { "id": "804d09f0-98c1-4382-91d3-c187c65cfa33", "name": "The updated in stock subscription object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"in_stock_subscriptions\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"_activate\": \"\",\n \"_deactivate\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"in_stock_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"inactive\",\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-804d09f0-98c1-4382-91d3-c187c65cfa33" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-44c882cb-374c-40d4-8d77-7c69efd1ad08" }, { "name": "Delete an in stock subscription", "id": "2525a1b6-9ea8-4db3-838d-9c2be705642f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId" ], "variable": [ { "id": "17e93114-9fb6-41ff-989c-80510dac8370", "key": "inStockSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an in stock subscription" }, "response": [ { "id": "70c0fa6a-74d4-4ed3-a422-13927b2068e5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions/:inStockSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions", ":inStockSubscriptionId" ], "variable": [ { "key": "inStockSubscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-70c0fa6a-74d4-4ed3-a422-13927b2068e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2525a1b6-9ea8-4db3-838d-9c2be705642f" } ], "id": "cd95d7fc-133a-4b7b-906a-343785ac4110", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cd95d7fc-133a-4b7b-906a-343785ac4110" }, { "name": "List all in stock subscriptions", "id": "57213754-6ae8-48b1-8764-744f23701bea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions" ] }, "description": "List all in stock subscriptions" }, "response": [ { "id": "58f60967-e634-42fc-81df-475a92b1da4f", "name": "A list of in stock subscription objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/in_stock_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"in_stock_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"inactive\",\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"in_stock_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"active\",\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-58f60967-e634-42fc-81df-475a92b1da4f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-57213754-6ae8-48b1-8764-744f23701bea" }, { "name": "Create an in stock subscription", "id": "b40345de-880f-48dd-89e0-b826024e0ab4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"in_stock_subscriptions\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/in_stock_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions" ] }, "description": "Create an in stock subscription" }, "response": [ { "id": "3df06630-8fda-421a-9091-6c0d174b038b", "name": "The created in stock subscription object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"in_stock_subscriptions\",\n \"attributes\": {\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/in_stock_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "in_stock_subscriptions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"in_stock_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"inactive\",\n \"customer_email\": \"\",\n \"sku_code\": \"\",\n \"stock_threshold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3df06630-8fda-421a-9091-6c0d174b038b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b40345de-880f-48dd-89e0-b826024e0ab4" } ], "id": "b080fa7f-a37b-4c17-97e6-432e5aae8ec5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b080fa7f-a37b-4c17-97e6-432e5aae8ec5" }, { "name": "inventory_models", "item": [ { "name": "{inventoryModelId}", "item": [ { "name": "inventory_stock_locations", "item": [ { "name": "Retrieve the inventory stock locations associated to the inventory model", "id": "6083002d-ecda-4421-81fa-a208c9b72100", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "inventory_stock_locations" ], "variable": [ { "id": "ab5af3ce-09a4-4474-8ae8-872ab488b1e8", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory stock locations associated to the inventory model" }, "response": [ { "id": "c6a11142-a7a6-420a-b4d5-610f4ec1fca8", "name": "The inventory_stock_locations associated to the inventory model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "inventory_stock_locations" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c6a11142-a7a6-420a-b4d5-610f4ec1fca8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6083002d-ecda-4421-81fa-a208c9b72100" } ], "id": "f59bc12a-3d53-482c-a7f9-c1d2d09d66c5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f59bc12a-3d53-482c-a7f9-c1d2d09d66c5" }, { "name": "inventory_return_locations", "item": [ { "name": "Retrieve the inventory return locations associated to the inventory model", "id": "726e7f25-c02f-473c-a5b3-e3cc44b76ccf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "inventory_return_locations" ], "variable": [ { "id": "67062f9e-5af8-4295-8898-d86fac5e77a7", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory return locations associated to the inventory model" }, "response": [ { "id": "e633e6b5-f339-4f59-b179-9067e84e27dd", "name": "The inventory_return_locations associated to the inventory model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "inventory_return_locations" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e633e6b5-f339-4f59-b179-9067e84e27dd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-726e7f25-c02f-473c-a5b3-e3cc44b76ccf" } ], "id": "dabce364-dbbe-4d36-9f0e-ec65fa0fc9f0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dabce364-dbbe-4d36-9f0e-ec65fa0fc9f0" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the inventory model", "id": "ba00cb37-26a8-45ea-882a-074d2e2f8cb5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "attachments" ], "variable": [ { "id": "40e8ca07-c954-41cd-8a70-8042cc556182", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the inventory model" }, "response": [ { "id": "1a861de4-c7d7-404b-9941-a670413db192", "name": "The attachments associated to the inventory model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "attachments" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1a861de4-c7d7-404b-9941-a670413db192" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba00cb37-26a8-45ea-882a-074d2e2f8cb5" } ], "id": "17e3013b-5cfb-4d54-87ad-8e5168d80b0f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-17e3013b-5cfb-4d54-87ad-8e5168d80b0f" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the inventory model", "id": "40397253-f6dc-43eb-a9c0-207ea03e6c4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "event_stores" ], "variable": [ { "id": "68f2eb52-c678-4dbf-9c84-7c3e4d4d06bf", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the inventory model" }, "response": [ { "id": "6e84342c-2cca-46ff-a0c2-2a0891e1660f", "name": "The event_stores associated to the inventory model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId", "event_stores" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6e84342c-2cca-46ff-a0c2-2a0891e1660f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-40397253-f6dc-43eb-a9c0-207ea03e6c4a" } ], "id": "5bc4904f-c2fe-43ab-8a7e-e0e6edc5cd7b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5bc4904f-c2fe-43ab-8a7e-e0e6edc5cd7b" }, { "name": "Retrieve an inventory model", "id": "62e6ce36-08b6-45ab-9836-b40aaf5b314c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId" ], "variable": [ { "id": "5b236dd9-ae23-4a9b-9695-c31652df6068", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an inventory model" }, "response": [ { "id": "62670a3b-cf34-45a3-a49b-ca18189c2e9c", "name": "The inventory model object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-62670a3b-cf34-45a3-a49b-ca18189c2e9c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-62e6ce36-08b6-45ab-9836-b40aaf5b314c" }, { "name": "Update an inventory model", "id": "755020a9-088e-4937-abd5-0659fb4a9d2d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId" ], "variable": [ { "id": "e8e04d79-76d7-4c5c-82ce-cef2b2ca2cce", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an inventory model" }, "response": [ { "id": "ee63c79c-0e31-4d45-84b4-7e94c1825609", "name": "The updated inventory model object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ee63c79c-0e31-4d45-84b4-7e94c1825609" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-755020a9-088e-4937-abd5-0659fb4a9d2d" }, { "name": "Delete an inventory model", "id": "3fe31de7-2934-4117-b65e-4abe5e0a3439", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId" ], "variable": [ { "id": "d3b79b40-f5d1-4edd-8793-dfea1ee45021", "key": "inventoryModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an inventory model" }, "response": [ { "id": "06731c5b-9e32-4d2f-b304-77cbece5c8a7", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models/:inventoryModelId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models", ":inventoryModelId" ], "variable": [ { "key": "inventoryModelId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-06731c5b-9e32-4d2f-b304-77cbece5c8a7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3fe31de7-2934-4117-b65e-4abe5e0a3439" } ], "id": "dd6ff4e4-a03b-455c-9773-962266e6d364", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dd6ff4e4-a03b-455c-9773-962266e6d364" }, { "name": "List all inventory models", "id": "8f82ea96-bf16-4751-8181-3fd4828eb3ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/inventory_models", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models" ] }, "description": "List all inventory models" }, "response": [ { "id": "c6fa704c-68a7-4e98-a2b1-edb00b51f731", "name": "A list of inventory model objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_models", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"inventory_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"inventory_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c6fa704c-68a7-4e98-a2b1-edb00b51f731" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8f82ea96-bf16-4751-8181-3fd4828eb3ce" }, { "name": "Create an inventory model", "id": "7e461db6-3c2b-43e0-afcb-ffdd30009f01", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_models\",\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_models", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models" ] }, "description": "Create an inventory model" }, "response": [ { "id": "e1c785c6-2096-4887-9a41-73759404d452", "name": "The created inventory model object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_models\",\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_models", "host": [ "{{baseUrl}}" ], "path": [ "inventory_models" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"stock_locations_cutoff\": \"\",\n \"stock_reservation_cutoff\": \"\",\n \"put_stock_transfers_on_hold\": \"\",\n \"manual_stock_decrement\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e1c785c6-2096-4887-9a41-73759404d452" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7e461db6-3c2b-43e0-afcb-ffdd30009f01" } ], "id": "10b8cb11-ff4b-4d1d-bf78-8375f16df6ad", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-10b8cb11-ff4b-4d1d-bf78-8375f16df6ad" }, { "name": "inventory_return_locations", "item": [ { "name": "{inventoryReturnLocationId}", "item": [ { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the inventory return location", "id": "538984ed-f637-4b12-bcaf-81e7bf2924ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId", "stock_location" ], "variable": [ { "id": "0232331c-4fbe-4310-9e82-9f5d5966d035", "key": "inventoryReturnLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the inventory return location" }, "response": [ { "id": "f8676179-4de9-4129-b452-6e10200ea310", "name": "The stock_location associated to the inventory return location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId", "stock_location" ], "variable": [ { "key": "inventoryReturnLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f8676179-4de9-4129-b452-6e10200ea310" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-538984ed-f637-4b12-bcaf-81e7bf2924ac" } ], "id": "2c8a8b3b-25bb-4f3d-8591-4d2cc5258f2a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2c8a8b3b-25bb-4f3d-8591-4d2cc5258f2a" }, { "name": "inventory_model", "item": [ { "name": "Retrieve the inventory model associated to the inventory return location", "id": "38254725-eeb8-484f-9bd2-27ca5c4d810a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId/inventory_model", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId", "inventory_model" ], "variable": [ { "id": "ca0d3144-ad40-4856-befc-937a54a2d972", "key": "inventoryReturnLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory model associated to the inventory return location" }, "response": [ { "id": "46cc44f0-5cf0-4a10-9f11-d9b45b9cb8a4", "name": "The inventory_model associated to the inventory return location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId/inventory_model", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId", "inventory_model" ], "variable": [ { "key": "inventoryReturnLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-46cc44f0-5cf0-4a10-9f11-d9b45b9cb8a4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-38254725-eeb8-484f-9bd2-27ca5c4d810a" } ], "id": "8f789774-bdd4-4838-a1cd-5b8c331be293", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8f789774-bdd4-4838-a1cd-5b8c331be293" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the inventory return location", "id": "2d36614f-1be6-4a03-8d76-a3cda7cbceb6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId", "event_stores" ], "variable": [ { "id": "aaf52bd9-902b-4622-96cb-cc8fb6666b20", "key": "inventoryReturnLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the inventory return location" }, "response": [ { "id": "821c5ad0-37d2-47b7-b575-929a7bdd38d8", "name": "The event_stores associated to the inventory return location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId", "event_stores" ], "variable": [ { "key": "inventoryReturnLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-821c5ad0-37d2-47b7-b575-929a7bdd38d8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d36614f-1be6-4a03-8d76-a3cda7cbceb6" } ], "id": "eb55fd41-9f03-4ba2-9219-f87ddc1b7b89", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-eb55fd41-9f03-4ba2-9219-f87ddc1b7b89" }, { "name": "Retrieve an inventory return location", "id": "692694f1-9eac-4d09-88d1-9db135c106af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId" ], "variable": [ { "id": "c359d2d0-d257-4a52-9324-94624ab49433", "key": "inventoryReturnLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an inventory return location" }, "response": [ { "id": "f8168291-0171-4b6d-9d1e-eb9dd703ef90", "name": "The inventory return location object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId" ], "variable": [ { "key": "inventoryReturnLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_return_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f8168291-0171-4b6d-9d1e-eb9dd703ef90" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-692694f1-9eac-4d09-88d1-9db135c106af" }, { "name": "Update an inventory return location", "id": "65e64647-3e46-457f-bf54-5925d05b1860", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\",\n \"attributes\": {\n \"priority\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId" ], "variable": [ { "id": "f52135f9-522a-49ba-89dd-e7ad8b5d80a5", "key": "inventoryReturnLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an inventory return location" }, "response": [ { "id": "bacd8e35-ba36-4623-86d4-6cf0209bfc29", "name": "The updated inventory return location object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\",\n \"attributes\": {\n \"priority\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId" ], "variable": [ { "key": "inventoryReturnLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_return_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bacd8e35-ba36-4623-86d4-6cf0209bfc29" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-65e64647-3e46-457f-bf54-5925d05b1860" }, { "name": "Delete an inventory return location", "id": "a8ddc1b5-27d7-4eff-a9da-baf4e5faf757", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId" ], "variable": [ { "id": "ac53a724-abaa-4cc9-96c1-8ebc8b56e62c", "key": "inventoryReturnLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an inventory return location" }, "response": [ { "id": "f82bcde0-5c5c-4467-b258-179fb0c70cd0", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations/:inventoryReturnLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations", ":inventoryReturnLocationId" ], "variable": [ { "key": "inventoryReturnLocationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f82bcde0-5c5c-4467-b258-179fb0c70cd0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8ddc1b5-27d7-4eff-a9da-baf4e5faf757" } ], "id": "bd4f7ee4-37c2-4048-a671-760fd09afd7f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bd4f7ee4-37c2-4048-a671-760fd09afd7f" }, { "name": "List all inventory return locations", "id": "f72a4432-80af-4cc2-a015-ba44decf815b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations" ] }, "description": "List all inventory return locations" }, "response": [ { "id": "e2d474a5-8e87-4381-83c4-4d6eebce85f6", "name": "A list of inventory return location objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"inventory_return_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"inventory_return_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e2d474a5-8e87-4381-83c4-4d6eebce85f6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f72a4432-80af-4cc2-a015-ba44decf815b" }, { "name": "Create an inventory return location", "id": "200b22bf-4b9f-4518-95d6-3b50bffe2c7e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"attributes\": {\n \"priority\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations" ] }, "description": "Create an inventory return location" }, "response": [ { "id": "ab71b59d-633e-4f5e-88d6-520be53cf44a", "name": "The created inventory return location object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"attributes\": {\n \"priority\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_return_locations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_return_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ab71b59d-633e-4f5e-88d6-520be53cf44a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-200b22bf-4b9f-4518-95d6-3b50bffe2c7e" } ], "id": "17b9b02b-8c6d-406b-a507-5accadf8dc2f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-17b9b02b-8c6d-406b-a507-5accadf8dc2f" }, { "name": "inventory_stock_locations", "item": [ { "name": "{inventoryStockLocationId}", "item": [ { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the inventory stock location", "id": "c19c0613-3af5-45aa-90d4-20229472c296", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId", "stock_location" ], "variable": [ { "id": "f2891b9b-74c2-445a-b3ef-f53aca1b9ba3", "key": "inventoryStockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the inventory stock location" }, "response": [ { "id": "a24f25ae-d7e1-4bda-ba5f-8c86bf0e816a", "name": "The stock_location associated to the inventory stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId", "stock_location" ], "variable": [ { "key": "inventoryStockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a24f25ae-d7e1-4bda-ba5f-8c86bf0e816a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c19c0613-3af5-45aa-90d4-20229472c296" } ], "id": "e1e26a60-4a5f-4fab-b3bc-06a9b7225723", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e1e26a60-4a5f-4fab-b3bc-06a9b7225723" }, { "name": "inventory_model", "item": [ { "name": "Retrieve the inventory model associated to the inventory stock location", "id": "b4f0632b-540e-41a8-bd4a-955f52c20183", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId/inventory_model", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId", "inventory_model" ], "variable": [ { "id": "d2b3c7ef-8736-4286-801f-77f1db55da52", "key": "inventoryStockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory model associated to the inventory stock location" }, "response": [ { "id": "14fbd305-5f64-4abe-8851-f5d088a4c992", "name": "The inventory_model associated to the inventory stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId/inventory_model", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId", "inventory_model" ], "variable": [ { "key": "inventoryStockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-14fbd305-5f64-4abe-8851-f5d088a4c992" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b4f0632b-540e-41a8-bd4a-955f52c20183" } ], "id": "a3e0eb08-fb71-4413-8d29-b621af89fca4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a3e0eb08-fb71-4413-8d29-b621af89fca4" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the inventory stock location", "id": "a07dbecc-e1ca-46ad-9a6b-bf066461c9fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId", "event_stores" ], "variable": [ { "id": "90855412-80b0-4aff-b1dc-0fa8c78bb468", "key": "inventoryStockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the inventory stock location" }, "response": [ { "id": "5f5848a7-b653-4e20-ade9-ab1e2919511b", "name": "The event_stores associated to the inventory stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId", "event_stores" ], "variable": [ { "key": "inventoryStockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5f5848a7-b653-4e20-ade9-ab1e2919511b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a07dbecc-e1ca-46ad-9a6b-bf066461c9fd" } ], "id": "36d1b876-f648-43c2-ac17-a38c01e29fa4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-36d1b876-f648-43c2-ac17-a38c01e29fa4" }, { "name": "Retrieve an inventory stock location", "id": "b18b38a1-7a89-45ae-b86b-2fb31f4ab8cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId" ], "variable": [ { "id": "d09ccc6c-cf7a-47a0-8499-897b47a1c6b2", "key": "inventoryStockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an inventory stock location" }, "response": [ { "id": "7938151b-7884-480a-b60e-3b1f04e4f9be", "name": "The inventory stock location object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId" ], "variable": [ { "key": "inventoryStockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7938151b-7884-480a-b60e-3b1f04e4f9be" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b18b38a1-7a89-45ae-b86b-2fb31f4ab8cc" }, { "name": "Update an inventory stock location", "id": "7578e77b-4b1e-459e-8bf7-b3016fe2ee6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\",\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId" ], "variable": [ { "id": "27f85139-ddb2-4db0-83c2-0f048d0506e8", "key": "inventoryStockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an inventory stock location" }, "response": [ { "id": "843cd03a-441c-453a-b9f1-ae2da1bf536b", "name": "The updated inventory stock location object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\",\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId" ], "variable": [ { "key": "inventoryStockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-843cd03a-441c-453a-b9f1-ae2da1bf536b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7578e77b-4b1e-459e-8bf7-b3016fe2ee6c" }, { "name": "Delete an inventory stock location", "id": "b8b8f1ba-c0da-4c93-99ae-295749e12fff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId" ], "variable": [ { "id": "35d95a5e-b60d-467f-9fec-935c15a0782e", "key": "inventoryStockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an inventory stock location" }, "response": [ { "id": "a361d53d-d48c-4a2b-8fe2-528b96684c4c", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations/:inventoryStockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations", ":inventoryStockLocationId" ], "variable": [ { "key": "inventoryStockLocationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a361d53d-d48c-4a2b-8fe2-528b96684c4c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b8b8f1ba-c0da-4c93-99ae-295749e12fff" } ], "id": "5ac3e543-2469-4f57-a282-98b6a79784f9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5ac3e543-2469-4f57-a282-98b6a79784f9" }, { "name": "List all inventory stock locations", "id": "a4ee669b-8510-466d-9dc7-547793b9ab75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations" ] }, "description": "List all inventory stock locations" }, "response": [ { "id": "67a8953e-3c8e-4bcd-8094-667565d10d12", "name": "A list of inventory stock location objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"inventory_stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"inventory_stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-67a8953e-3c8e-4bcd-8094-667565d10d12" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a4ee669b-8510-466d-9dc7-547793b9ab75" }, { "name": "Create an inventory stock location", "id": "a3922138-5c0e-4a2f-b300-96afeff92169", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations" ] }, "description": "Create an inventory stock location" }, "response": [ { "id": "d0f24564-00cd-40d9-b075-2aecaa60fb2b", "name": "The created inventory stock location object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "inventory_stock_locations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"inventory_stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"priority\": \"\",\n \"on_hold\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d0f24564-00cd-40d9-b075-2aecaa60fb2b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a3922138-5c0e-4a2f-b300-96afeff92169" } ], "id": "0b353b80-f952-4485-af4d-0a5b73561d08", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0b353b80-f952-4485-af4d-0a5b73561d08" }, { "name": "klarna_gateways", "item": [ { "name": "{klarnaGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the klarna gateway", "id": "43508d2d-6906-4675-a7d4-fd539dc735e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId", "payment_methods" ], "variable": [ { "id": "b4752f5f-1e9c-46c0-90d9-87416e858052", "key": "klarnaGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the klarna gateway" }, "response": [ { "id": "d08e1842-c163-47c0-8473-bb687d043454", "name": "The payment_methods associated to the klarna gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId", "payment_methods" ], "variable": [ { "key": "klarnaGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d08e1842-c163-47c0-8473-bb687d043454" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-43508d2d-6906-4675-a7d4-fd539dc735e3" } ], "id": "4761416e-5a51-4bf1-9686-29334429fe21", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4761416e-5a51-4bf1-9686-29334429fe21" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the klarna gateway", "id": "d9d66f61-d3c2-4fa6-8111-44ff7b6508a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId", "event_stores" ], "variable": [ { "id": "53bb02e0-252c-44d1-bde1-3c33fce8f5de", "key": "klarnaGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the klarna gateway" }, "response": [ { "id": "531b7702-0c10-4cce-8d0a-891af5736c58", "name": "The event_stores associated to the klarna gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId", "event_stores" ], "variable": [ { "key": "klarnaGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-531b7702-0c10-4cce-8d0a-891af5736c58" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9d66f61-d3c2-4fa6-8111-44ff7b6508a4" } ], "id": "db47caa7-31d6-4e33-a130-c181792f5048", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-db47caa7-31d6-4e33-a130-c181792f5048" }, { "name": "klarna_payments", "item": [ { "name": "Retrieve the klarna payments associated to the klarna gateway", "id": "f15da26e-3d5e-4eac-bfac-26db5b48c24e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId/klarna_payments", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId", "klarna_payments" ], "variable": [ { "id": "874a53d3-44d2-4af1-9c98-377be6013808", "key": "klarnaGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the klarna payments associated to the klarna gateway" }, "response": [ { "id": "bd515200-b05d-46a7-bba4-d16b0edf3da6", "name": "The klarna_payments associated to the klarna gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId/klarna_payments", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId", "klarna_payments" ], "variable": [ { "key": "klarnaGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bd515200-b05d-46a7-bba4-d16b0edf3da6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f15da26e-3d5e-4eac-bfac-26db5b48c24e" } ], "id": "92ae8494-dace-47ec-aaab-f1e3d4339053", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-92ae8494-dace-47ec-aaab-f1e3d4339053" }, { "name": "Retrieve a klarna gateway", "id": "78b3ae74-2c5a-486b-b9f5-d2eaf71e666b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId" ], "variable": [ { "id": "24148b95-4121-4532-bd21-5d11723c46ad", "key": "klarnaGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a klarna gateway" }, "response": [ { "id": "bcd98f5d-353d-4a92-97f0-1761e3914f74", "name": "The klarna gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId" ], "variable": [ { "key": "klarnaGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"klarna_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"klarna_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bcd98f5d-353d-4a92-97f0-1761e3914f74" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-78b3ae74-2c5a-486b-b9f5-d2eaf71e666b" }, { "name": "Update a klarna gateway", "id": "97bf259f-3b90-4976-a189-cd665b921cbc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"country_code\": \"\",\n \"api_key\": \"\",\n \"api_secret\": \"\"\n },\n \"relationships\": {\n \"klarna_payments\": {\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId" ], "variable": [ { "id": "8a94a6a9-fd9b-46a1-bda1-c0c108d943fc", "key": "klarnaGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a klarna gateway" }, "response": [ { "id": "73c79be6-bb04-4519-9059-7b0c1c53d08a", "name": "The updated klarna gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"country_code\": \"\",\n \"api_key\": \"\",\n \"api_secret\": \"\"\n },\n \"relationships\": {\n \"klarna_payments\": {\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId" ], "variable": [ { "key": "klarnaGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"klarna_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"klarna_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-73c79be6-bb04-4519-9059-7b0c1c53d08a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-97bf259f-3b90-4976-a189-cd665b921cbc" }, { "name": "Delete a klarna gateway", "id": "de7f613e-73c0-4806-82de-7bb2184fc4d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId" ], "variable": [ { "id": "8cea250e-8cbb-408b-8619-d2e284bf920a", "key": "klarnaGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a klarna gateway" }, "response": [ { "id": "aa1632a4-7f86-4a73-826e-bf2d0494b8a0", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_gateways/:klarnaGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways", ":klarnaGatewayId" ], "variable": [ { "key": "klarnaGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aa1632a4-7f86-4a73-826e-bf2d0494b8a0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-de7f613e-73c0-4806-82de-7bb2184fc4d7" } ], "id": "7bceea61-7011-4c55-ae09-2a48fbc0fb5d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7bceea61-7011-4c55-ae09-2a48fbc0fb5d" }, { "name": "List all klarna gateways", "id": "ca31dae5-ff1a-4088-916a-7d61a98a900a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/klarna_gateways", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways" ] }, "description": "List all klarna gateways" }, "response": [ { "id": "6198b585-2945-41bb-a036-42a4744fd433", "name": "A list of klarna gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_gateways", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"klarna_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"klarna_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"klarna_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"klarna_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6198b585-2945-41bb-a036-42a4744fd433" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ca31dae5-ff1a-4088-916a-7d61a98a900a" }, { "name": "Create a klarna gateway", "id": "cca84f5d-d827-4a8e-ae0d-8532b4d88273", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"country_code\": \"\",\n \"api_key\": \"\",\n \"api_secret\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"klarna_payments\": {\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_gateways", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways" ] }, "description": "Create a klarna gateway" }, "response": [ { "id": "2bfa52b0-08b9-43fa-be8f-a3f8ac32d66d", "name": "The created klarna gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"country_code\": \"\",\n \"api_key\": \"\",\n \"api_secret\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"klarna_payments\": {\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_gateways", "host": [ "{{baseUrl}}" ], "path": [ "klarna_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"klarna_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"klarna_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2bfa52b0-08b9-43fa-be8f-a3f8ac32d66d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cca84f5d-d827-4a8e-ae0d-8532b4d88273" } ], "id": "181bdab7-e18d-4aa9-bcf5-412b320cc9b7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-181bdab7-e18d-4aa9-bcf5-412b320cc9b7" }, { "name": "klarna_payments", "item": [ { "name": "{klarnaPaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the klarna payment", "id": "088daf5f-ced1-46f8-a29f-c3e66cbbaaaa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId", "order" ], "variable": [ { "id": "4de66ab2-684f-49a8-98ac-c25484d45d4b", "key": "klarnaPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the klarna payment" }, "response": [ { "id": "9c3155e3-9d33-4770-9535-ad23e029ae5c", "name": "The order associated to the klarna payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId", "order" ], "variable": [ { "key": "klarnaPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9c3155e3-9d33-4770-9535-ad23e029ae5c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-088daf5f-ced1-46f8-a29f-c3e66cbbaaaa" } ], "id": "d2a2a190-f3ae-40a5-bcb1-b7dadebe1a7b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d2a2a190-f3ae-40a5-bcb1-b7dadebe1a7b" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the klarna payment", "id": "4cf02b55-ff5b-465d-b716-96ecb8d33035", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId", "payment_gateway" ], "variable": [ { "id": "51ad7bfa-a91b-4960-8495-2bb92f9e5441", "key": "klarnaPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the klarna payment" }, "response": [ { "id": "16ce9781-3ea3-4bf6-b0e9-36f25e3e3ed1", "name": "The payment_gateway associated to the klarna payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId", "payment_gateway" ], "variable": [ { "key": "klarnaPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-16ce9781-3ea3-4bf6-b0e9-36f25e3e3ed1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4cf02b55-ff5b-465d-b716-96ecb8d33035" } ], "id": "64df54ab-61e3-4ac0-83ef-bb0a1de65647", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-64df54ab-61e3-4ac0-83ef-bb0a1de65647" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the klarna payment", "id": "e694dbcc-48d4-4ac6-8ef3-1ecd7a0b1571", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId", "event_stores" ], "variable": [ { "id": "ef28c57c-7215-4a7b-8678-923a40923900", "key": "klarnaPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the klarna payment" }, "response": [ { "id": "18dd2027-d348-4af6-9796-ba82ded314d8", "name": "The event_stores associated to the klarna payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId", "event_stores" ], "variable": [ { "key": "klarnaPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-18dd2027-d348-4af6-9796-ba82ded314d8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e694dbcc-48d4-4ac6-8ef3-1ecd7a0b1571" } ], "id": "b67da439-81b8-4d93-ae54-dc82995dd59c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b67da439-81b8-4d93-ae54-dc82995dd59c" }, { "name": "Retrieve a klarna payment", "id": "d4f0d70f-b308-41ed-a1d6-f2fbc14a6679", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId" ], "variable": [ { "id": "24568bd9-b966-4512-a95e-3f56e152d50f", "key": "klarnaPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a klarna payment" }, "response": [ { "id": "8eec63df-ddc2-415e-a4b8-538309a13bb5", "name": "The klarna payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId" ], "variable": [ { "key": "klarnaPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"klarna_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"session_id\": \"\",\n \"client_token\": \"\",\n \"auth_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8eec63df-ddc2-415e-a4b8-538309a13bb5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d4f0d70f-b308-41ed-a1d6-f2fbc14a6679" }, { "name": "Update a klarna payment", "id": "9a1f9caa-74b1-422a-946f-49673279d2ef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"auth_token\": \"\",\n \"_update\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId" ], "variable": [ { "id": "9cac1566-6973-42c8-b3a9-51510ee69048", "key": "klarnaPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a klarna payment" }, "response": [ { "id": "83cda1fc-1427-414a-a7f8-74790d47dbd6", "name": "The updated klarna payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"auth_token\": \"\",\n \"_update\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId" ], "variable": [ { "key": "klarnaPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"klarna_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"session_id\": \"\",\n \"client_token\": \"\",\n \"auth_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-83cda1fc-1427-414a-a7f8-74790d47dbd6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9a1f9caa-74b1-422a-946f-49673279d2ef" }, { "name": "Delete a klarna payment", "id": "1d130410-d7bb-4a0f-b157-338c3c5ac7ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId" ], "variable": [ { "id": "7d76d675-b6c0-4e52-8cc3-a73a873963f2", "key": "klarnaPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a klarna payment" }, "response": [ { "id": "6a6160a5-f0aa-4de1-816c-a04f47698ff6", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_payments/:klarnaPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments", ":klarnaPaymentId" ], "variable": [ { "key": "klarnaPaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6a6160a5-f0aa-4de1-816c-a04f47698ff6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1d130410-d7bb-4a0f-b157-338c3c5ac7ce" } ], "id": "7dfa9d23-5523-4467-8d55-54861b40e67e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7dfa9d23-5523-4467-8d55-54861b40e67e" }, { "name": "List all klarna payments", "id": "e417a229-1078-4249-8eae-4879c65490a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/klarna_payments", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments" ] }, "description": "List all klarna payments" }, "response": [ { "id": "ad63f8e5-e8a1-48ba-91e0-a1bda1fa9726", "name": "A list of klarna payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/klarna_payments", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"klarna_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"session_id\": \"\",\n \"client_token\": \"\",\n \"auth_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"klarna_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"session_id\": \"\",\n \"client_token\": \"\",\n \"auth_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ad63f8e5-e8a1-48ba-91e0-a1bda1fa9726" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e417a229-1078-4249-8eae-4879c65490a1" }, { "name": "Create a klarna payment", "id": "df2613c5-43c0-44f1-a2f1-18a81facb219", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_payments\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_payments", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments" ] }, "description": "Create a klarna payment" }, "response": [ { "id": "ad0a46c5-18df-42af-81f9-1a7440aa574b", "name": "The created klarna payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"klarna_payments\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/klarna_payments", "host": [ "{{baseUrl}}" ], "path": [ "klarna_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"klarna_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"session_id\": \"\",\n \"client_token\": \"\",\n \"auth_token\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ad0a46c5-18df-42af-81f9-1a7440aa574b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-df2613c5-43c0-44f1-a2f1-18a81facb219" } ], "id": "fcab5d93-f881-495b-9078-7ddd6f664b0b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fcab5d93-f881-495b-9078-7ddd6f664b0b" }, { "name": "line_item_options", "item": [ { "name": "{lineItemOptionId}", "item": [ { "name": "line_item", "item": [ { "name": "Retrieve the line item associated to the line item option", "id": "6d8bfeb4-f6a8-4d7f-b1e4-653aa9c72b36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "line_item" ], "variable": [ { "id": "64cc6916-a8c1-47e2-bda5-ea8bcc8598cd", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item associated to the line item option" }, "response": [ { "id": "523af4ae-c44f-4820-8102-bab8a28a2e45", "name": "The line_item associated to the line item option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "line_item" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-523af4ae-c44f-4820-8102-bab8a28a2e45" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6d8bfeb4-f6a8-4d7f-b1e4-653aa9c72b36" } ], "id": "b72024ad-1eaf-41ad-bb18-aab9ff2e6a78", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b72024ad-1eaf-41ad-bb18-aab9ff2e6a78" }, { "name": "sku_option", "item": [ { "name": "Retrieve the sku option associated to the line item option", "id": "16b24934-d26a-4ed6-affb-032979024921", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/sku_option", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "sku_option" ], "variable": [ { "id": "648aede4-ea98-4c08-a682-dae93671d206", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku option associated to the line item option" }, "response": [ { "id": "c57a93d8-d3ba-4cfb-b2ce-8ac094597da8", "name": "The sku_option associated to the line item option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/sku_option", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "sku_option" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c57a93d8-d3ba-4cfb-b2ce-8ac094597da8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-16b24934-d26a-4ed6-affb-032979024921" } ], "id": "416ba5a6-fd06-4b22-b696-ed5585cbcbec", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-416ba5a6-fd06-4b22-b696-ed5585cbcbec" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the line item option", "id": "c6b1701d-c528-4d05-b80f-0b7049512e06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "events" ], "variable": [ { "id": "34152eb7-35c8-4c32-9149-4a705fc1fa1d", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the line item option" }, "response": [ { "id": "ce2ae6cd-6ce2-4005-bc2f-a60b3804ad19", "name": "The events associated to the line item option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "events" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ce2ae6cd-6ce2-4005-bc2f-a60b3804ad19" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c6b1701d-c528-4d05-b80f-0b7049512e06" } ], "id": "2966272d-5783-478a-a25c-0ca0a2f42669", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2966272d-5783-478a-a25c-0ca0a2f42669" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the line item option", "id": "6c440474-f589-46c7-aacb-20cb7c275d54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "tags" ], "variable": [ { "id": "52fb65ce-e8b7-4426-a3f7-4886e8f87241", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the line item option" }, "response": [ { "id": "9736d93c-b5a0-4d3a-9755-622ad9d2dece", "name": "The tags associated to the line item option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "tags" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9736d93c-b5a0-4d3a-9755-622ad9d2dece" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6c440474-f589-46c7-aacb-20cb7c275d54" } ], "id": "4f2fcd5e-747a-49b7-bd10-52f739880bbc", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4f2fcd5e-747a-49b7-bd10-52f739880bbc" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the line item option", "id": "7de28f09-78b0-4da3-9bd7-2f8d7c1caaca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "event_stores" ], "variable": [ { "id": "f9e24f67-0b84-4813-9fcb-f92b5b96da3d", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the line item option" }, "response": [ { "id": "37f1f3e6-caa3-4603-8bba-e6d1fd89e335", "name": "The event_stores associated to the line item option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId", "event_stores" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-37f1f3e6-caa3-4603-8bba-e6d1fd89e335" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7de28f09-78b0-4da3-9bd7-2f8d7c1caaca" } ], "id": "d2c41b06-4f9b-4e1a-ac69-5107197114a0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d2c41b06-4f9b-4e1a-ac69-5107197114a0" }, { "name": "Retrieve a line item option", "id": "c3efaabf-cec2-4aa8-8160-b2409d1134f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId" ], "variable": [ { "id": "b4cc42bc-bd2b-46f0-a95f-7d20d7a0da28", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a line item option" }, "response": [ { "id": "9513a46e-3f53-43b7-ab79-8370b62c8816", "name": "The line item option object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"line_item_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"options\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_option\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9513a46e-3f53-43b7-ab79-8370b62c8816" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c3efaabf-cec2-4aa8-8160-b2409d1134f7" }, { "name": "Update a line item option", "id": "f054be76-036a-49ce-9196-d4505cb4514a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"options\": {},\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_option\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId" ], "variable": [ { "id": "e70f6f61-0d8c-492b-aa28-f0a6ab23dc27", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a line item option" }, "response": [ { "id": "1b3ffb57-70c0-464f-a21c-f7483a416893", "name": "The updated line item option object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"options\": {},\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_option\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"line_item_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"options\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_option\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1b3ffb57-70c0-464f-a21c-f7483a416893" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f054be76-036a-49ce-9196-d4505cb4514a" }, { "name": "Delete a line item option", "id": "5bf9158a-9b8d-4eeb-b9d8-13d2eafa3533", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId" ], "variable": [ { "id": "b6cf6bbf-9188-4437-ad46-138e27b9a449", "key": "lineItemOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a line item option" }, "response": [ { "id": "a9304bec-c7e1-42d6-86db-befa7f4b671a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options/:lineItemOptionId", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options", ":lineItemOptionId" ], "variable": [ { "key": "lineItemOptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a9304bec-c7e1-42d6-86db-befa7f4b671a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5bf9158a-9b8d-4eeb-b9d8-13d2eafa3533" } ], "id": "cdebd305-a1bc-46d9-a7eb-0de7b2018684", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cdebd305-a1bc-46d9-a7eb-0de7b2018684" }, { "name": "List all line item options", "id": "98cd7fe0-8ad2-4276-97ea-7c98ee0649c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options" ] }, "description": "List all line item options" }, "response": [ { "id": "7696b670-46ca-4942-91d3-fea658595384", "name": "A list of line item option objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"line_item_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"options\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_option\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"line_item_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"options\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_option\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7696b670-46ca-4942-91d3-fea658595384" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98cd7fe0-8ad2-4276-97ea-7c98ee0649c9" }, { "name": "Create a line item option", "id": "4d74f36b-6bc1-4239-8708-d0597f7f6d25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_item_options\",\n \"attributes\": {\n \"quantity\": \"\",\n \"options\": {},\n \"name\": \"\",\n \"unit_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options" ] }, "description": "Create a line item option" }, "response": [ { "id": "8332547e-05a8-44ae-9f69-ce6f05cdcc35", "name": "The created line item option object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_item_options\",\n \"attributes\": {\n \"quantity\": \"\",\n \"options\": {},\n \"name\": \"\",\n \"unit_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "line_item_options" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"line_item_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"quantity\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"options\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"sku_option\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_option\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8332547e-05a8-44ae-9f69-ce6f05cdcc35" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4d74f36b-6bc1-4239-8708-d0597f7f6d25" } ], "id": "bc192d42-f74b-4ef6-b655-62f375f26080", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bc192d42-f74b-4ef6-b655-62f375f26080" }, { "name": "line_items", "item": [ { "name": "{lineItemId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the line item", "id": "de777393-902b-4e0f-98ad-08d41533d29e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/order", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "order" ], "variable": [ { "id": "a235d5fa-24fd-4196-b7f2-96db5182f001", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the line item" }, "response": [ { "id": "4a317323-22bb-4171-9275-91c6c7431a8c", "name": "The order associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/order", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "order" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4a317323-22bb-4171-9275-91c6c7431a8c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-de777393-902b-4e0f-98ad-08d41533d29e" } ], "id": "7982a186-23b9-42cb-875d-60e080f5ae68", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7982a186-23b9-42cb-875d-60e080f5ae68" }, { "name": "line_item_options", "item": [ { "name": "Retrieve the line item options associated to the line item", "id": "3f6070bc-805a-4b1a-9497-5e02c53f1de7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "line_item_options" ], "variable": [ { "id": "c12a0758-60bd-47ea-927a-da9955eeae40", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item options associated to the line item" }, "response": [ { "id": "a0aba549-f638-415d-9194-17ae1946c2f0", "name": "The line_item_options associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "line_item_options" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a0aba549-f638-415d-9194-17ae1946c2f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3f6070bc-805a-4b1a-9497-5e02c53f1de7" } ], "id": "a45bcff8-e186-4d8a-b520-7b370a8fd07f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a45bcff8-e186-4d8a-b520-7b370a8fd07f" }, { "name": "return_line_items", "item": [ { "name": "Retrieve the return line items associated to the line item", "id": "f0fe5d61-ecdb-4665-a844-0d4b3a19f97a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "return_line_items" ], "variable": [ { "id": "34d7ea6f-2440-4fd6-89a8-1d85bb240f68", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the return line items associated to the line item" }, "response": [ { "id": "48d331c8-f9a6-4adc-b2fd-c0ff4560a304", "name": "The return_line_items associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "return_line_items" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-48d331c8-f9a6-4adc-b2fd-c0ff4560a304" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f0fe5d61-ecdb-4665-a844-0d4b3a19f97a" } ], "id": "49a09efc-5c83-4b36-a204-c9bb0d2c3b58", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-49a09efc-5c83-4b36-a204-c9bb0d2c3b58" }, { "name": "stock_reservations", "item": [ { "name": "Retrieve the stock reservations associated to the line item", "id": "1a133bc7-e19a-4d12-80b7-eebc7039b0d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "stock_reservations" ], "variable": [ { "id": "43fb77a4-3910-4b55-82ac-66db25775f87", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservations associated to the line item" }, "response": [ { "id": "66760545-371e-4e7a-993f-6c53a3cc75e6", "name": "The stock_reservations associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "stock_reservations" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-66760545-371e-4e7a-993f-6c53a3cc75e6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1a133bc7-e19a-4d12-80b7-eebc7039b0d4" } ], "id": "f1aadf14-53e7-42d0-979e-5158a3d745cd", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f1aadf14-53e7-42d0-979e-5158a3d745cd" }, { "name": "stock_line_items", "item": [ { "name": "Retrieve the stock line items associated to the line item", "id": "5bc97f75-be70-4d6a-82cc-c18dd47cfee6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "stock_line_items" ], "variable": [ { "id": "329215b1-a5fa-4ce5-a0d2-8b1ec4aa69a1", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock line items associated to the line item" }, "response": [ { "id": "2a4e7ef1-ab5d-4a02-a46e-581a25f824a9", "name": "The stock_line_items associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "stock_line_items" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2a4e7ef1-ab5d-4a02-a46e-581a25f824a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5bc97f75-be70-4d6a-82cc-c18dd47cfee6" } ], "id": "a52c4183-0ee0-4a8b-a937-8785546c8c00", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a52c4183-0ee0-4a8b-a937-8785546c8c00" }, { "name": "stock_transfers", "item": [ { "name": "Retrieve the stock transfers associated to the line item", "id": "3fc3590f-8f70-4170-bddc-da8f7b685b7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "stock_transfers" ], "variable": [ { "id": "dc2a8e41-dfee-43a2-b440-950c4697efca", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock transfers associated to the line item" }, "response": [ { "id": "9c638051-b767-484f-9188-d06d51c03818", "name": "The stock_transfers associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "stock_transfers" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9c638051-b767-484f-9188-d06d51c03818" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3fc3590f-8f70-4170-bddc-da8f7b685b7a" } ], "id": "7e6ac2f2-f825-4277-994b-5c574c970cd8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7e6ac2f2-f825-4277-994b-5c574c970cd8" }, { "name": "notifications", "item": [ { "name": "Retrieve the notifications associated to the line item", "id": "6d1bd6df-f11f-4a5f-9904-a9283d809894", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "notifications" ], "variable": [ { "id": "99177100-dc37-4bcf-9a77-0473e8cece05", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the notifications associated to the line item" }, "response": [ { "id": "044a0190-354a-4c79-9f2b-51edc69df434", "name": "The notifications associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "notifications" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-044a0190-354a-4c79-9f2b-51edc69df434" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6d1bd6df-f11f-4a5f-9904-a9283d809894" } ], "id": "5ea0a1e8-fd5a-47f0-acf5-9f5b3c85abd9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5ea0a1e8-fd5a-47f0-acf5-9f5b3c85abd9" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the line item", "id": "d64ea10f-6387-4772-aceb-380bf5ed96e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/events", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "events" ], "variable": [ { "id": "0897dbd3-9fbd-4582-a5c2-80cf48345577", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the line item" }, "response": [ { "id": "c687c93d-3ecc-425f-a431-3d03bfe3ab54", "name": "The events associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/events", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "events" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c687c93d-3ecc-425f-a431-3d03bfe3ab54" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d64ea10f-6387-4772-aceb-380bf5ed96e4" } ], "id": "a7d88f1c-a85b-4f6e-974f-3dd126a2e2e7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a7d88f1c-a85b-4f6e-974f-3dd126a2e2e7" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the line item", "id": "5127c5d1-d727-4c4a-95b3-7a3cb9c19648", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "tags" ], "variable": [ { "id": "f5f76557-ab98-497e-8e31-66ae712ff6fb", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the line item" }, "response": [ { "id": "61fea2b5-92c1-468a-9cf8-ab57ef53531f", "name": "The tags associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/tags", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "tags" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-61fea2b5-92c1-468a-9cf8-ab57ef53531f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5127c5d1-d727-4c4a-95b3-7a3cb9c19648" } ], "id": "abe366b9-1c1c-425e-8307-13bb01f10d25", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-abe366b9-1c1c-425e-8307-13bb01f10d25" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the line item", "id": "d3a06c19-ee02-4e1a-8db2-36d263d0c025", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "event_stores" ], "variable": [ { "id": "99f3fbe3-4337-4fbb-b445-0371d5aefabc", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the line item" }, "response": [ { "id": "2d4ef0d6-1673-41de-a747-8a671df5e78e", "name": "The event_stores associated to the line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId", "event_stores" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2d4ef0d6-1673-41de-a747-8a671df5e78e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d3a06c19-ee02-4e1a-8db2-36d263d0c025" } ], "id": "4f5171f2-0cd6-4563-b0ac-bbc5404377fb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4f5171f2-0cd6-4563-b0ac-bbc5404377fb" }, { "name": "Retrieve a line item", "id": "3d28668a-ecb4-40a8-83a6-17e94622dc60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId" ], "variable": [ { "id": "9dcc8faf-eddc-459e-b469-759dcbc10d85", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a line item" }, "response": [ { "id": "c47c9539-be58-422e-a647-faa16d6332d1", "name": "The line item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"discount_engine_items\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c47c9539-be58-422e-a647-faa16d6332d1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3d28668a-ecb4-40a8-83a6-17e94622dc60" }, { "name": "Update a line item", "id": "437f4673-cb28-4ab6-bc62-a992b08e5a07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"_reserve_stock\": \"\",\n \"_reset_restocked_quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"options_amount_cents\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"frequency\": \"\",\n \"_reset_circuit\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_items/:lineItemId", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId" ], "variable": [ { "id": "0a2ed24c-4951-4ab9-a55b-e3ffcfece077", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a line item" }, "response": [ { "id": "d434fc94-5703-4cd9-9697-e8874e94eeac", "name": "The updated line item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"_reserve_stock\": \"\",\n \"_reset_restocked_quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"options_amount_cents\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"frequency\": \"\",\n \"_reset_circuit\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_items/:lineItemId", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"discount_engine_items\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d434fc94-5703-4cd9-9697-e8874e94eeac" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-437f4673-cb28-4ab6-bc62-a992b08e5a07" }, { "name": "Delete a line item", "id": "961350bd-79c6-40c5-b7c3-209085a2b369", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId" ], "variable": [ { "id": "bf36a760-6e8d-44c3-9571-e9f18194973f", "key": "lineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a line item" }, "response": [ { "id": "bcb56bc4-5fc7-469e-8cfd-5f7174207f9b", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items/:lineItemId", "host": [ "{{baseUrl}}" ], "path": [ "line_items", ":lineItemId" ], "variable": [ { "key": "lineItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bcb56bc4-5fc7-469e-8cfd-5f7174207f9b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-961350bd-79c6-40c5-b7c3-209085a2b369" } ], "id": "15f3e78d-ce4b-431e-8ff1-4ed23d404900", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-15f3e78d-ce4b-431e-8ff1-4ed23d404900" }, { "name": "List all line items", "id": "7fea51cd-0d7d-4f18-a84c-5e9ac6258f15", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items" ] }, "description": "List all line items" }, "response": [ { "id": "b6f8fe40-9b19-4999-9c10-da622f4f0b2d", "name": "A list of line item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"gift_cards\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"external_promotions\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b6f8fe40-9b19-4999-9c10-da622f4f0b2d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7fea51cd-0d7d-4f18-a84c-5e9ac6258f15" }, { "name": "Create a line item", "id": "65b47339-0670-4eb6-8003-8b79c302745d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"_external_price\": \"\",\n \"_update_quantity\": \"\",\n \"_reserve_stock\": \"\",\n \"_reset_restocked_quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"item_type\": \"shipments\",\n \"frequency\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items" ] }, "description": "Create a line item" }, "response": [ { "id": "cff705bf-646b-42c3-a4ef-d1a2b0b26a3d", "name": "The created line item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"_external_price\": \"\",\n \"_update_quantity\": \"\",\n \"_reserve_stock\": \"\",\n \"_reset_restocked_quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"item_type\": \"shipments\",\n \"frequency\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/line_items", "host": [ "{{baseUrl}}" ], "path": [ "line_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"discount_engine_items\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"gift_card\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cff705bf-646b-42c3-a4ef-d1a2b0b26a3d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-65b47339-0670-4eb6-8003-8b79c302745d" } ], "id": "b947c714-7db9-4bb8-9e2d-1fa6610ade36", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b947c714-7db9-4bb8-9e2d-1fa6610ade36" }, { "name": "links", "item": [ { "name": "{linkId}", "item": [ { "name": "events", "item": [ { "name": "Retrieve the events associated to the link", "id": "2d83726a-5ed7-4aa7-b6a8-c40cebf1e324", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/links/:linkId/events", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId", "events" ], "variable": [ { "id": "cf31bc46-dc59-4346-bba1-7076fc516a52", "key": "linkId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the link" }, "response": [ { "id": "0c40f2cd-5bcf-4f70-9916-0f737b87ab36", "name": "The events associated to the link", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/links/:linkId/events", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId", "events" ], "variable": [ { "key": "linkId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0c40f2cd-5bcf-4f70-9916-0f737b87ab36" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d83726a-5ed7-4aa7-b6a8-c40cebf1e324" } ], "id": "436e17fa-b48b-4fe4-bab0-5c4cf1083ded", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-436e17fa-b48b-4fe4-bab0-5c4cf1083ded" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the link", "id": "88adb82a-a8c5-4dda-b5c3-1713f5d024f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/links/:linkId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId", "event_stores" ], "variable": [ { "id": "0c01e1bd-3d13-4c23-bf48-61b15a46d1e1", "key": "linkId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the link" }, "response": [ { "id": "b68e43e3-a7dd-4a32-af8f-df536c74fe33", "name": "The event_stores associated to the link", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/links/:linkId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId", "event_stores" ], "variable": [ { "key": "linkId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b68e43e3-a7dd-4a32-af8f-df536c74fe33" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-88adb82a-a8c5-4dda-b5c3-1713f5d024f3" } ], "id": "7d626c69-9d89-4a3a-95b2-c4fc99a1e9a0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7d626c69-9d89-4a3a-95b2-c4fc99a1e9a0" }, { "name": "Retrieve a link", "id": "f1215568-cbd8-4528-b132-101f40949fab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId" ], "variable": [ { "id": "d3fcc8de-a90f-41b3-b50b-c7cf55fe02e8", "key": "linkId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a link" }, "response": [ { "id": "39e50c8b-9ed1-4810-967e-96989563d031", "name": "The link object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId" ], "variable": [ { "key": "linkId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"links\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"domain\": \"\",\n \"url\": \"\",\n \"item_type\": \"orders\",\n \"params\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-39e50c8b-9ed1-4810-967e-96989563d031" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f1215568-cbd8-4528-b132-101f40949fab" }, { "name": "Update a link", "id": "c0c71d88-4f02-4237-92eb-0d565670c704", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"domain\": \"\",\n \"params\": {},\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"approved\",\n \"payment_status\": \"partially_authorized\",\n \"fulfillment_status\": \"in_progress\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"discount_engine_item\": {\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"captures\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"authorizations\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId" ], "variable": [ { "id": "df9e0faa-b50e-4e0a-8812-9ea2c0e34d65", "key": "linkId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a link" }, "response": [ { "id": "0d743b33-589b-486f-a456-2df4fdcdf982", "name": "The updated link object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"domain\": \"\",\n \"params\": {},\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"approved\",\n \"payment_status\": \"partially_authorized\",\n \"fulfillment_status\": \"in_progress\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"discount_engine_item\": {\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"captures\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"authorizations\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId" ], "variable": [ { "key": "linkId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"links\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"domain\": \"\",\n \"url\": \"\",\n \"item_type\": \"orders\",\n \"params\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0d743b33-589b-486f-a456-2df4fdcdf982" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c0c71d88-4f02-4237-92eb-0d565670c704" }, { "name": "Delete a link", "id": "19c6efe0-4a10-4b46-9eaa-2863f5922b35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId" ], "variable": [ { "id": "49145849-88d7-4297-89c3-57ce3dec7ece", "key": "linkId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a link" }, "response": [ { "id": "8c3ab8c1-8d43-455f-ad97-5aeac48242e7", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/links/:linkId", "host": [ "{{baseUrl}}" ], "path": [ "links", ":linkId" ], "variable": [ { "key": "linkId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8c3ab8c1-8d43-455f-ad97-5aeac48242e7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19c6efe0-4a10-4b46-9eaa-2863f5922b35" } ], "id": "f99de4dc-7087-4888-80d1-f35c49de9af5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f99de4dc-7087-4888-80d1-f35c49de9af5" }, { "name": "List all links", "id": "09174813-2e32-4740-b257-3dce574aec14", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/links", "host": [ "{{baseUrl}}" ], "path": [ "links" ] }, "description": "List all links" }, "response": [ { "id": "53f4f5e6-2e66-4773-9008-c99e1691030d", "name": "A list of link objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/links", "host": [ "{{baseUrl}}" ], "path": [ "links" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"links\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"domain\": \"\",\n \"url\": \"\",\n \"item_type\": \"orders\",\n \"params\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"links\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"domain\": \"\",\n \"url\": \"\",\n \"item_type\": \"orders\",\n \"params\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-53f4f5e6-2e66-4773-9008-c99e1691030d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-09174813-2e32-4740-b257-3dce574aec14" }, { "name": "Create a link", "id": "62d4f9b6-05a2-435b-bd29-e141e945edd3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"links\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"domain\": \"\",\n \"item_type\": \"skus\",\n \"params\": {},\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"draft\",\n \"payment_status\": \"voided\",\n \"fulfillment_status\": \"not_required\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"discount_engine_item\": {\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"authorizations\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/links", "host": [ "{{baseUrl}}" ], "path": [ "links" ] }, "description": "Create a link" }, "response": [ { "id": "05df2220-cda4-4d8d-bfb8-c3b9792a9bd5", "name": "The created link object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"links\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"domain\": \"\",\n \"item_type\": \"skus\",\n \"params\": {},\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"draft\",\n \"payment_status\": \"voided\",\n \"fulfillment_status\": \"not_required\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"discount_engine_item\": {\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cvv_code\": \"\",\n \"cvv_message\": \"\",\n \"avs_code\": \"\",\n \"avs_message\": \"\",\n \"fraud_review\": \"\",\n \"capture_amount_cents\": \"\",\n \"capture_amount_float\": \"\",\n \"formatted_capture_amount\": \"\",\n \"capture_balance_cents\": \"\",\n \"capture_balance_float\": \"\",\n \"formatted_capture_balance\": \"\",\n \"void_balance_cents\": \"\",\n \"void_balance_float\": \"\",\n \"formatted_void_balance\": \"\"\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"authorizations\": {\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/links", "host": [ "{{baseUrl}}" ], "path": [ "links" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"links\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"scope\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"domain\": \"\",\n \"url\": \"\",\n \"item_type\": \"orders\",\n \"params\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-05df2220-cda4-4d8d-bfb8-c3b9792a9bd5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-62d4f9b6-05a2-435b-bd29-e141e945edd3" } ], "id": "4c5481d3-3daa-4b90-836d-b874493caed5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4c5481d3-3daa-4b90-836d-b874493caed5" }, { "name": "manual_gateways", "item": [ { "name": "{manualGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the manual gateway", "id": "b96f5f31-be98-4303-bf09-ad7a2fd4220c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId", "payment_methods" ], "variable": [ { "id": "23a5118f-1b4a-4e52-95d3-eeaf7c500e50", "key": "manualGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the manual gateway" }, "response": [ { "id": "835b00d7-b616-4349-9d61-d88ee40b9a7a", "name": "The payment_methods associated to the manual gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId", "payment_methods" ], "variable": [ { "key": "manualGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-835b00d7-b616-4349-9d61-d88ee40b9a7a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b96f5f31-be98-4303-bf09-ad7a2fd4220c" } ], "id": "8fc2f103-d535-493f-92c3-c683c24bd94d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8fc2f103-d535-493f-92c3-c683c24bd94d" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the manual gateway", "id": "91d3f721-0fb6-4b17-93eb-f476f8af51fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId", "event_stores" ], "variable": [ { "id": "faa8ee0a-1bdd-43ff-a02b-2ccc6b1b6a86", "key": "manualGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the manual gateway" }, "response": [ { "id": "00895ef7-e48a-436b-bfc1-03230da85d3a", "name": "The event_stores associated to the manual gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId", "event_stores" ], "variable": [ { "key": "manualGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-00895ef7-e48a-436b-bfc1-03230da85d3a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-91d3f721-0fb6-4b17-93eb-f476f8af51fd" } ], "id": "f9ba44ad-3a3f-444a-bca3-6b9ef4160eb0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f9ba44ad-3a3f-444a-bca3-6b9ef4160eb0" }, { "name": "Retrieve a manual gateway", "id": "a8789154-f78d-43c3-b1bb-a73490e493b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId" ], "variable": [ { "id": "5b52498e-c0b4-487c-b2c0-762a5b055460", "key": "manualGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a manual gateway" }, "response": [ { "id": "98a16140-77ac-4598-9134-4ae4a95a650b", "name": "The manual gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId" ], "variable": [ { "key": "manualGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"manual_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-98a16140-77ac-4598-9134-4ae4a95a650b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8789154-f78d-43c3-b1bb-a73490e493b2" }, { "name": "Update a manual gateway", "id": "cfce22d4-77c7-42b3-86bd-86ed7a9fc2f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId" ], "variable": [ { "id": "2f167c5b-8812-4b56-9d2a-cc38ced8c85f", "key": "manualGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a manual gateway" }, "response": [ { "id": "d3ceebec-561c-4e8e-9efd-4bd019d0b3d3", "name": "The updated manual gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId" ], "variable": [ { "key": "manualGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"manual_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d3ceebec-561c-4e8e-9efd-4bd019d0b3d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cfce22d4-77c7-42b3-86bd-86ed7a9fc2f4" }, { "name": "Delete a manual gateway", "id": "4c210bb9-83bd-4240-9b2c-45999bee6c43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId" ], "variable": [ { "id": "31fe06fd-31b7-4f6b-ad4c-75acb3a61f64", "key": "manualGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a manual gateway" }, "response": [ { "id": "7d3a07f2-21a0-4cb4-a43b-3926c3801340", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_gateways/:manualGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways", ":manualGatewayId" ], "variable": [ { "key": "manualGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7d3a07f2-21a0-4cb4-a43b-3926c3801340" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4c210bb9-83bd-4240-9b2c-45999bee6c43" } ], "id": "50d97410-a877-4a29-a032-71c9ad081d7f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-50d97410-a877-4a29-a032-71c9ad081d7f" }, { "name": "List all manual gateways", "id": "d04235e5-c420-4da7-b7b0-1edf664fc7b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/manual_gateways", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways" ] }, "description": "List all manual gateways" }, "response": [ { "id": "362ec76c-9e37-4f73-9c25-02d8298c83ad", "name": "A list of manual gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_gateways", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"manual_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"manual_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-362ec76c-9e37-4f73-9c25-02d8298c83ad" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d04235e5-c420-4da7-b7b0-1edf664fc7b4" }, { "name": "Create a manual gateway", "id": "c87b1a1f-6c05-4a40-8531-85dc715c786c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_gateways", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways" ] }, "description": "Create a manual gateway" }, "response": [ { "id": "5df96224-56e6-4daa-9cb5-b6adf60ad429", "name": "The created manual gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_gateways", "host": [ "{{baseUrl}}" ], "path": [ "manual_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"manual_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5df96224-56e6-4daa-9cb5-b6adf60ad429" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c87b1a1f-6c05-4a40-8531-85dc715c786c" } ], "id": "d260eac7-50cf-44e5-beba-6365cab01fed", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d260eac7-50cf-44e5-beba-6365cab01fed" }, { "name": "manual_tax_calculators", "item": [ { "name": "{manualTaxCalculatorId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the manual tax calculator", "id": "9d4510da-6203-4494-b2c0-6c19f6e93f72", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/markets", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "markets" ], "variable": [ { "id": "2af58a2d-9254-4aff-9978-65884496a469", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the manual tax calculator" }, "response": [ { "id": "a8eb0aac-9147-437d-8097-d6a1d9cdc6b1", "name": "The markets associated to the manual tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/markets", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "markets" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a8eb0aac-9147-437d-8097-d6a1d9cdc6b1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9d4510da-6203-4494-b2c0-6c19f6e93f72" } ], "id": "5b66ab59-3027-4004-bfcf-68a87528f2cd", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5b66ab59-3027-4004-bfcf-68a87528f2cd" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the manual tax calculator", "id": "0add48fe-41e7-4816-86de-0160afad1497", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "attachments" ], "variable": [ { "id": "06428990-4b29-4377-8538-b2c439db6d10", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the manual tax calculator" }, "response": [ { "id": "ab019d9e-9398-4a81-ab2a-7000b494cd33", "name": "The attachments associated to the manual tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "attachments" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ab019d9e-9398-4a81-ab2a-7000b494cd33" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0add48fe-41e7-4816-86de-0160afad1497" } ], "id": "e1fe5410-65d8-4e08-a408-779678cd7816", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e1fe5410-65d8-4e08-a408-779678cd7816" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the manual tax calculator", "id": "f511cb0f-5795-4561-8324-5b706a95f975", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/events", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "events" ], "variable": [ { "id": "1316a849-1d40-4248-9173-cd24d16f8869", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the manual tax calculator" }, "response": [ { "id": "064e2cfc-cab2-4b1e-b05a-da3661158364", "name": "The events associated to the manual tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/events", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "events" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-064e2cfc-cab2-4b1e-b05a-da3661158364" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f511cb0f-5795-4561-8324-5b706a95f975" } ], "id": "0a4c2382-07c6-447d-88c0-3101e2c79968", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0a4c2382-07c6-447d-88c0-3101e2c79968" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the manual tax calculator", "id": "47c5e140-2ba6-4105-a5f6-09c87ba960c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "event_stores" ], "variable": [ { "id": "89c14794-10ad-4fb9-97ea-188cc0a25141", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the manual tax calculator" }, "response": [ { "id": "c17e1659-f180-4496-961e-93b272b3b898", "name": "The event_stores associated to the manual tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "event_stores" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c17e1659-f180-4496-961e-93b272b3b898" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-47c5e140-2ba6-4105-a5f6-09c87ba960c0" } ], "id": "d9018b73-220c-405d-8e22-736a287e2bc1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d9018b73-220c-405d-8e22-736a287e2bc1" }, { "name": "tax_rules", "item": [ { "name": "Retrieve the tax rules associated to the manual tax calculator", "id": "ccdccb8c-8fa1-4f4b-8507-f1adf037ffc0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "tax_rules" ], "variable": [ { "id": "ec850701-70ce-4527-b41d-de429993dbe3", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tax rules associated to the manual tax calculator" }, "response": [ { "id": "4cf9cfb9-0611-48b2-9d64-932d9c979da0", "name": "The tax_rules associated to the manual tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId", "tax_rules" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4cf9cfb9-0611-48b2-9d64-932d9c979da0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ccdccb8c-8fa1-4f4b-8507-f1adf037ffc0" } ], "id": "092abf7c-f3e9-4616-835c-504377260378", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-092abf7c-f3e9-4616-835c-504377260378" }, { "name": "Retrieve a manual tax calculator", "id": "3c1799e5-fc62-4cd4-8ceb-00c7d9d95a27", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId" ], "variable": [ { "id": "c317cd8f-1b2c-44e3-a8a9-b0143f0277c8", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a manual tax calculator" }, "response": [ { "id": "396ffe91-dbad-4685-abd7-934e6c0c2610", "name": "The manual tax calculator object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-396ffe91-dbad-4685-abd7-934e6c0c2610" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3c1799e5-fc62-4cd4-8ceb-00c7d9d95a27" }, { "name": "Update a manual tax calculator", "id": "5ceb56ab-6e7f-4887-b5e3-ddc91584b24b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tax_rules\": {\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId" ], "variable": [ { "id": "80fa2e4a-d01a-4dde-b755-2842cc8ce3ab", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a manual tax calculator" }, "response": [ { "id": "d36d0fe6-99fc-4427-b2fa-ac99afe534fd", "name": "The updated manual tax calculator object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tax_rules\": {\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d36d0fe6-99fc-4427-b2fa-ac99afe534fd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5ceb56ab-6e7f-4887-b5e3-ddc91584b24b" }, { "name": "Delete a manual tax calculator", "id": "eae218ed-2caf-462e-b600-5b00773152e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId" ], "variable": [ { "id": "1d1bb424-f07c-4312-9e00-fbdf46d52f3c", "key": "manualTaxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a manual tax calculator" }, "response": [ { "id": "df65c885-f243-4877-9fe8-0c05f2848f85", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators/:manualTaxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators", ":manualTaxCalculatorId" ], "variable": [ { "key": "manualTaxCalculatorId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df65c885-f243-4877-9fe8-0c05f2848f85" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eae218ed-2caf-462e-b600-5b00773152e1" } ], "id": "a0262a7c-b74e-4a28-b2ff-fe0768eb4bd3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a0262a7c-b74e-4a28-b2ff-fe0768eb4bd3" }, { "name": "List all manual tax calculators", "id": "8d58567a-1a3b-420d-9917-f51e4b8c0315", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators" ] }, "description": "List all manual tax calculators" }, "response": [ { "id": "a780229d-fc1e-4db1-9ca3-aa1d0d32075a", "name": "A list of manual tax calculator objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/manual_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"avalara_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a780229d-fc1e-4db1-9ca3-aa1d0d32075a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8d58567a-1a3b-420d-9917-f51e4b8c0315" }, { "name": "Create a manual tax calculator", "id": "8883eb43-1186-4dc2-b653-21147bbace44", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tax_rules\": {\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators" ] }, "description": "Create a manual tax calculator" }, "response": [ { "id": "c4b93e6d-3819-466d-9cd7-19b3148e3794", "name": "The created manual tax calculator object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tax_rules\": {\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/manual_tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "manual_tax_calculators" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c4b93e6d-3819-466d-9cd7-19b3148e3794" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8883eb43-1186-4dc2-b653-21147bbace44" } ], "id": "e41e1e0b-af18-4fba-904a-d716d684dfc9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e41e1e0b-af18-4fba-904a-d716d684dfc9" }, { "name": "markets", "item": [ { "name": "{marketId}", "item": [ { "name": "merchant", "item": [ { "name": "Retrieve the merchant associated to the market", "id": "2010ae2e-6ffa-484f-bbb0-0bc49f0b8980", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/merchant", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "merchant" ], "variable": [ { "id": "114bf2b2-7b8e-4441-acef-c7637558f7c3", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the merchant associated to the market" }, "response": [ { "id": "c42c467c-f371-45c3-8974-a5420fd6f0ac", "name": "The merchant associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/merchant", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "merchant" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c42c467c-f371-45c3-8974-a5420fd6f0ac" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2010ae2e-6ffa-484f-bbb0-0bc49f0b8980" } ], "id": "8849b7d2-14db-4c7d-be1f-29730b219a14", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8849b7d2-14db-4c7d-be1f-29730b219a14" }, { "name": "price_list", "item": [ { "name": "Retrieve the price list associated to the market", "id": "3af5d0e8-2c80-4694-ab20-91ebef7d0217", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/price_list", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "price_list" ], "variable": [ { "id": "f46f28ca-dca1-4bca-ae48-fae0a798c101", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price list associated to the market" }, "response": [ { "id": "f4444ee9-4f40-4064-baa6-fb91fe6527e6", "name": "The price_list associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/price_list", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "price_list" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f4444ee9-4f40-4064-baa6-fb91fe6527e6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3af5d0e8-2c80-4694-ab20-91ebef7d0217" } ], "id": "5b811193-624f-43ad-ad4f-856aa85dedc1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5b811193-624f-43ad-ad4f-856aa85dedc1" }, { "name": "base_price_list", "item": [ { "name": "Retrieve the base price list associated to the market", "id": "f4e5e0cf-5c6f-4322-9d9b-438297f7d4ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/base_price_list", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "base_price_list" ], "variable": [ { "id": "214bbb53-da36-493d-8aae-761ef9788539", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the base price list associated to the market" }, "response": [ { "id": "3e3985db-ba48-464c-be2c-6918677b45f4", "name": "The base_price_list associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/base_price_list", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "base_price_list" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3e3985db-ba48-464c-be2c-6918677b45f4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f4e5e0cf-5c6f-4322-9d9b-438297f7d4ce" } ], "id": "ca9cc470-6554-4892-a02e-6c5341d31e05", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ca9cc470-6554-4892-a02e-6c5341d31e05" }, { "name": "inventory_model", "item": [ { "name": "Retrieve the inventory model associated to the market", "id": "8aa45ca3-5021-43bf-bf7e-fdb60839a57a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/inventory_model", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "inventory_model" ], "variable": [ { "id": "55b46b15-2d33-4e90-8665-aaa9cd56739c", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory model associated to the market" }, "response": [ { "id": "0561455f-3474-433a-85f8-8cf138778da2", "name": "The inventory_model associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/inventory_model", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "inventory_model" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0561455f-3474-433a-85f8-8cf138778da2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8aa45ca3-5021-43bf-bf7e-fdb60839a57a" } ], "id": "234a4df3-e4cf-4e5d-bde1-c0807863c135", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-234a4df3-e4cf-4e5d-bde1-c0807863c135" }, { "name": "subscription_model", "item": [ { "name": "Retrieve the subscription model associated to the market", "id": "010e0572-aab9-4870-8677-399e5eb705c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/subscription_model", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "subscription_model" ], "variable": [ { "id": "b85b3782-d870-455e-ae62-2d77edaae5ed", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the subscription model associated to the market" }, "response": [ { "id": "09989028-fa41-45ac-9907-4b2f997cf18e", "name": "The subscription_model associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/subscription_model", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "subscription_model" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-09989028-fa41-45ac-9907-4b2f997cf18e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-010e0572-aab9-4870-8677-399e5eb705c4" } ], "id": "ca49acd9-be9a-40a8-86b0-44671d3cda65", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ca49acd9-be9a-40a8-86b0-44671d3cda65" }, { "name": "discount_engine", "item": [ { "name": "Retrieve the discount engine associated to the market", "id": "83f7c9f7-5f1d-44ab-92a1-70b8a564ccd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/discount_engine", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "discount_engine" ], "variable": [ { "id": "b285a3a4-2015-49a9-a3a1-3fd4d7f65a32", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the discount engine associated to the market" }, "response": [ { "id": "47eb1456-2453-4e5f-8810-254d2f0b3fca", "name": "The discount_engine associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/discount_engine", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "discount_engine" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-47eb1456-2453-4e5f-8810-254d2f0b3fca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83f7c9f7-5f1d-44ab-92a1-70b8a564ccd5" } ], "id": "64cb5a35-97ac-4fe1-9a56-1202d76536da", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-64cb5a35-97ac-4fe1-9a56-1202d76536da" }, { "name": "customer_group", "item": [ { "name": "Retrieve the customer group associated to the market", "id": "0ec21f06-e233-46ed-b46c-2e808a5bd0de", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/customer_group", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "customer_group" ], "variable": [ { "id": "9b11693d-1f34-4378-a1ea-9140397892e8", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer group associated to the market" }, "response": [ { "id": "47478cce-5fad-47a0-976c-d5fef7dbacbd", "name": "The customer_group associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/customer_group", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "customer_group" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-47478cce-5fad-47a0-976c-d5fef7dbacbd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0ec21f06-e233-46ed-b46c-2e808a5bd0de" } ], "id": "36ca1200-99d4-4a8e-98dc-ce5b5378771f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-36ca1200-99d4-4a8e-98dc-ce5b5378771f" }, { "name": "geocoder", "item": [ { "name": "Retrieve the geocoder associated to the market", "id": "66bb8732-3b86-4982-a459-fae4368874fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/geocoder", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "geocoder" ], "variable": [ { "id": "aa526e5a-b64f-4674-ae59-6a91e9013e6e", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the geocoder associated to the market" }, "response": [ { "id": "308ae008-8fd8-4d78-84ee-d8a0d9d94802", "name": "The geocoder associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/geocoder", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "geocoder" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-308ae008-8fd8-4d78-84ee-d8a0d9d94802" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-66bb8732-3b86-4982-a459-fae4368874fb" } ], "id": "dc0b4c9a-bb73-49d9-954d-347bd095c5b7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dc0b4c9a-bb73-49d9-954d-347bd095c5b7" }, { "name": "default_shipping_method", "item": [ { "name": "Retrieve the default shipping method associated to the market", "id": "644d2028-7d63-4cab-b45b-916a9fcbf7a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/default_shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "default_shipping_method" ], "variable": [ { "id": "5a44105a-be05-45f2-a490-d45602d0a025", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the default shipping method associated to the market" }, "response": [ { "id": "da1fa47c-aed5-4926-9b0f-aada521cc3bc", "name": "The default_shipping_method associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/default_shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "default_shipping_method" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-da1fa47c-aed5-4926-9b0f-aada521cc3bc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-644d2028-7d63-4cab-b45b-916a9fcbf7a6" } ], "id": "e3406373-8d5c-44f6-b3cb-6fdacb74349d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e3406373-8d5c-44f6-b3cb-6fdacb74349d" }, { "name": "default_payment_method", "item": [ { "name": "Retrieve the default payment method associated to the market", "id": "11d58765-a85d-4317-8555-80f3b23ff220", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/default_payment_method", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "default_payment_method" ], "variable": [ { "id": "4cc9a024-4c3d-4ec4-8e9e-033cf83af5d9", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the default payment method associated to the market" }, "response": [ { "id": "06eecb51-c280-4779-8c8b-c80609465c0d", "name": "The default_payment_method associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/default_payment_method", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "default_payment_method" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-06eecb51-c280-4779-8c8b-c80609465c0d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-11d58765-a85d-4317-8555-80f3b23ff220" } ], "id": "6737b823-47ae-4b77-810a-287664a7d5aa", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6737b823-47ae-4b77-810a-287664a7d5aa" }, { "name": "stores", "item": [ { "name": "Retrieve the stores associated to the market", "id": "bb498c5c-78a6-4d0c-933e-2f0a93ab0b74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/stores", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "stores" ], "variable": [ { "id": "25829dff-9569-416c-bac9-a6ea58f026a6", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stores associated to the market" }, "response": [ { "id": "cf527d61-2bfe-43f6-84ab-1edb64b3c3e5", "name": "The stores associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/stores", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "stores" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cf527d61-2bfe-43f6-84ab-1edb64b3c3e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bb498c5c-78a6-4d0c-933e-2f0a93ab0b74" } ], "id": "c47e3721-dab1-4b2b-9f33-e08c28d1183f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c47e3721-dab1-4b2b-9f33-e08c28d1183f" }, { "name": "price_list_schedulers", "item": [ { "name": "Retrieve the price list schedulers associated to the market", "id": "f2788765-eade-47ba-aa93-570b664b88a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "price_list_schedulers" ], "variable": [ { "id": "8cea4dc0-b00d-46c4-b93a-63746ee23e6f", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price list schedulers associated to the market" }, "response": [ { "id": "502e8c54-1af8-42b4-9c62-99e24ddc42bc", "name": "The price_list_schedulers associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "price_list_schedulers" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-502e8c54-1af8-42b4-9c62-99e24ddc42bc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f2788765-eade-47ba-aa93-570b664b88a7" } ], "id": "8fb5b9c7-566e-480b-9044-82a5129b2c66", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8fb5b9c7-566e-480b-9044-82a5129b2c66" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the market", "id": "2826b493-c027-4ad9-89be-ee550c96238c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "attachments" ], "variable": [ { "id": "bb7c80f4-0a4d-4da4-8f34-b2163fb02d11", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the market" }, "response": [ { "id": "6ad70d76-4541-4f23-8338-6671616a5f6f", "name": "The attachments associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "attachments" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6ad70d76-4541-4f23-8338-6671616a5f6f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2826b493-c027-4ad9-89be-ee550c96238c" } ], "id": "4346f6e8-ee73-45d5-aba3-84249e75ec44", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4346f6e8-ee73-45d5-aba3-84249e75ec44" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the market", "id": "521c3c63-7883-4fae-9fc6-2a6c38030bd9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "event_stores" ], "variable": [ { "id": "28bc648b-3960-4c10-b936-5363dda9e470", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the market" }, "response": [ { "id": "a8ffa566-8cef-43b7-8e41-9670925f2bac", "name": "The event_stores associated to the market", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId", "event_stores" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a8ffa566-8cef-43b7-8e41-9670925f2bac" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-521c3c63-7883-4fae-9fc6-2a6c38030bd9" } ], "id": "7879a255-95d3-4057-a66f-4e402108321f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7879a255-95d3-4057-a66f-4e402108321f" }, { "name": "Retrieve a market", "id": "1c948db1-521a-414e-9263-5bee3315b93c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/markets/:marketId", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId" ], "variable": [ { "id": "b3fbe930-d841-403c-b9a3-1d3a876838aa", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a market" }, "response": [ { "id": "582661d4-cd10-49f1-9a9e-19571dc55bcc", "name": "The market object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"markets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"private\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"disabled_at\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"base_price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"base_price_list\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-582661d4-cd10-49f1-9a9e-19571dc55bcc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1c948db1-521a-414e-9263-5bee3315b93c" }, { "name": "Update a market", "id": "779b8bae-97bd-4b86-b8c2-2a5b4d96cbd3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"data\": {\n \"type\": \"subscription_models\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"data\": {\n \"type\": \"discount_engines\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"avalara_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/markets/:marketId", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId" ], "variable": [ { "id": "fb6c3f02-6070-4d26-872b-6cdf10fce223", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a market" }, "response": [ { "id": "e4919f5d-a4ce-4166-85e7-fa49641a73c6", "name": "The updated market object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"data\": {\n \"type\": \"subscription_models\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"data\": {\n \"type\": \"discount_engines\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"avalara_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/markets/:marketId", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId" ], "variable": [ { "key": "marketId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"markets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"private\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"disabled_at\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"base_price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"base_price_list\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e4919f5d-a4ce-4166-85e7-fa49641a73c6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-779b8bae-97bd-4b86-b8c2-2a5b4d96cbd3" }, { "name": "Delete a market", "id": "05fb1e58-41e6-4ab8-a8cc-979e1ae27224", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/markets/:marketId", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId" ], "variable": [ { "id": "ec41d7ae-242c-4fc1-b6ac-b8dea13675ef", "key": "marketId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a market" }, "response": [ { "id": "96ea5457-b57c-4515-a398-732f8ce93b62", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets/:marketId", "host": [ "{{baseUrl}}" ], "path": [ "markets", ":marketId" ], "variable": [ { "key": "marketId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-96ea5457-b57c-4515-a398-732f8ce93b62" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-05fb1e58-41e6-4ab8-a8cc-979e1ae27224" } ], "id": "19a2dcd7-9973-4809-9409-42bd253e0fad", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-19a2dcd7-9973-4809-9409-42bd253e0fad" }, { "name": "List all markets", "id": "8a1660dd-731c-419c-b603-3f04e64440e8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/markets", "host": [ "{{baseUrl}}" ], "path": [ "markets" ] }, "description": "List all markets" }, "response": [ { "id": "334f090e-0d08-479b-95dc-6d01896e77b1", "name": "A list of market objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/markets", "host": [ "{{baseUrl}}" ], "path": [ "markets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"markets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"private\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"disabled_at\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"base_price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"base_price_list\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"markets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"private\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"disabled_at\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"base_price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"base_price_list\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-334f090e-0d08-479b-95dc-6d01896e77b1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8a1660dd-731c-419c-b603-3f04e64440e8" }, { "name": "Create a market", "id": "707366ab-3bb5-4b82-a26b-f4ad2fb394cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"markets\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"data\": {\n \"type\": \"subscription_models\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"data\": {\n \"type\": \"discount_engines\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/markets", "host": [ "{{baseUrl}}" ], "path": [ "markets" ] }, "description": "Create a market" }, "response": [ { "id": "8720c18b-6058-4a80-a0d2-816f3c0f3140", "name": "The created market object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"markets\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"data\": {\n \"type\": \"inventory_models\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"data\": {\n \"type\": \"subscription_models\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"data\": {\n \"type\": \"discount_engines\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"customer_group\": {\n \"data\": {\n \"type\": \"customer_groups\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"data\": {\n \"type\": \"geocoders\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/markets", "host": [ "{{baseUrl}}" ], "path": [ "markets" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"markets\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"facebook_pixel_id\": \"\",\n \"checkout_url\": \"\",\n \"external_prices_url\": \"\",\n \"external_order_validation_url\": \"\",\n \"private\": \"\",\n \"shipping_cost_cutoff\": \"\",\n \"disabled_at\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"base_price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"base_price_list\",\n \"id\": \"\"\n }\n },\n \"inventory_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_model\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"discount_engine\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"customer_group\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_group\",\n \"id\": \"\"\n }\n },\n \"geocoder\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"geocoder\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8720c18b-6058-4a80-a0d2-816f3c0f3140" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-707366ab-3bb5-4b82-a26b-f4ad2fb394cc" } ], "id": "7338fd55-2691-4819-a5d8-48ec815fb8fd", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7338fd55-2691-4819-a5d8-48ec815fb8fd" }, { "name": "merchants", "item": [ { "name": "{merchantId}", "item": [ { "name": "address", "item": [ { "name": "Retrieve the address associated to the merchant", "id": "3eb9ecc9-4138-4253-ab47-fe6daa019a89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/address", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "address" ], "variable": [ { "id": "84ed121e-4cba-487b-99ed-a87a1a072517", "key": "merchantId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the address associated to the merchant" }, "response": [ { "id": "90cfb3e8-e031-4b51-a576-ab042b2a2d5b", "name": "The address associated to the merchant", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/address", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "address" ], "variable": [ { "key": "merchantId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-90cfb3e8-e031-4b51-a576-ab042b2a2d5b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3eb9ecc9-4138-4253-ab47-fe6daa019a89" } ], "id": "51074c41-4da2-41f9-9eb1-434fbb1fde6a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-51074c41-4da2-41f9-9eb1-434fbb1fde6a" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the merchant", "id": "de390eae-396e-4740-bb06-041270a8b02f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "attachments" ], "variable": [ { "id": "8557e7ce-5cbf-455f-9115-6f4bd2a6ecee", "key": "merchantId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the merchant" }, "response": [ { "id": "54c9aa61-cf5f-46bb-aa1d-be9caf1a979d", "name": "The attachments associated to the merchant", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "attachments" ], "variable": [ { "key": "merchantId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-54c9aa61-cf5f-46bb-aa1d-be9caf1a979d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-de390eae-396e-4740-bb06-041270a8b02f" } ], "id": "64cf452b-0e17-412a-b5b6-1be5eb384eab", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-64cf452b-0e17-412a-b5b6-1be5eb384eab" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the merchant", "id": "a835cc2d-9f8b-4949-b130-f4d6f3f9f407", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "event_stores" ], "variable": [ { "id": "f7ec64f3-1625-4de2-a4cc-f7e5c65ee910", "key": "merchantId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the merchant" }, "response": [ { "id": "7dd1e5a7-b156-49f2-b92e-c1a3d919ceba", "name": "The event_stores associated to the merchant", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId", "event_stores" ], "variable": [ { "key": "merchantId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7dd1e5a7-b156-49f2-b92e-c1a3d919ceba" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a835cc2d-9f8b-4949-b130-f4d6f3f9f407" } ], "id": "62f5b6f7-6465-4e26-aeff-0d3f9b13b996", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-62f5b6f7-6465-4e26-aeff-0d3f9b13b996" }, { "name": "Retrieve a merchant", "id": "00e31bc0-f996-4a43-9d3b-fba6cd9335ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "id": "50a95f76-c80a-4d58-ba41-9d68a22b979e", "key": "merchantId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a merchant" }, "response": [ { "id": "39c1a51a-a64b-48d7-a2af-0b16fc9a892e", "name": "The merchant object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "key": "merchantId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"merchants\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-39c1a51a-a64b-48d7-a2af-0b16fc9a892e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-00e31bc0-f996-4a43-9d3b-fba6cd9335ce" }, { "name": "Update a merchant", "id": "3c2a7f88-11f4-4d66-b01a-7dd639d245f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "id": "ecfdb2b1-8233-4fed-a61f-af9635ce5464", "key": "merchantId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a merchant" }, "response": [ { "id": "c3eaf389-9a38-4cf3-8b38-87000c4a32e9", "name": "The updated merchant object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "key": "merchantId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"merchants\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c3eaf389-9a38-4cf3-8b38-87000c4a32e9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3c2a7f88-11f4-4d66-b01a-7dd639d245f6" }, { "name": "Delete a merchant", "id": "7be516a0-9c28-42b8-b58e-97157bfa57ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "id": "8d5f0d01-50a3-41f6-8304-caafa0e54518", "key": "merchantId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a merchant" }, "response": [ { "id": "7500004a-395c-4b78-95ea-24624e2303ba", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/merchants/:merchantId", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchantId" ], "variable": [ { "key": "merchantId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7500004a-395c-4b78-95ea-24624e2303ba" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7be516a0-9c28-42b8-b58e-97157bfa57ee" } ], "id": "7776c324-a2f3-49c9-a7b3-6084f9f3f3a6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7776c324-a2f3-49c9-a7b3-6084f9f3f3a6" }, { "name": "List all merchants", "id": "a650cf88-7a45-420a-a7d2-5f682dcd9693", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] }, "description": "List all merchants" }, "response": [ { "id": "bb0842b6-0d27-47e0-b0aa-ba62d0bd9bfd", "name": "A list of merchant objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"merchants\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"merchants\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bb0842b6-0d27-47e0-b0aa-ba62d0bd9bfd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a650cf88-7a45-420a-a7d2-5f682dcd9693" }, { "name": "Create a merchant", "id": "49238975-108c-41ae-8ec3-f741db678bd9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"merchants\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] }, "description": "Create a merchant" }, "response": [ { "id": "f383b4d1-eb1b-496e-bb95-a05949386489", "name": "The created merchant object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"merchants\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"merchants\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f383b4d1-eb1b-496e-bb95-a05949386489" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-49238975-108c-41ae-8ec3-f741db678bd9" } ], "id": "fdf108d5-0072-4701-ad08-9cbb5568e921", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fdf108d5-0072-4701-ad08-9cbb5568e921" }, { "name": "notifications", "item": [ { "name": "{notificationId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the notification", "id": "111ab118-970e-46cd-9a50-0a0050318c01", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/notifications/:notificationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId", "event_stores" ], "variable": [ { "id": "db63538a-8eff-4933-9369-760700bb875f", "key": "notificationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the notification" }, "response": [ { "id": "5843a3b6-a24d-4c0e-901e-26f9d21a7f2c", "name": "The event_stores associated to the notification", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/notifications/:notificationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId", "event_stores" ], "variable": [ { "key": "notificationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5843a3b6-a24d-4c0e-901e-26f9d21a7f2c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-111ab118-970e-46cd-9a50-0a0050318c01" } ], "id": "a5c5e4cf-d65b-4f8a-a39d-49db0fbf4e45", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a5c5e4cf-d65b-4f8a-a39d-49db0fbf4e45" }, { "name": "Retrieve a notification", "id": "ba06356f-9c30-4fa4-8d22-69e5b5f94ed5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId" ], "variable": [ { "id": "439e46c5-a0ce-4226-bd0a-3f1e64ce7ff8", "key": "notificationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a notification" }, "response": [ { "id": "19df2d94-51d1-4dca-ba93-164b754145e5", "name": "The notification object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId" ], "variable": [ { "key": "notificationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifiable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-19df2d94-51d1-4dca-ba93-164b754145e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba06356f-9c30-4fa4-8d22-69e5b5f94ed5" }, { "name": "Update a notification", "id": "10714d2e-f41a-49cc-90f0-ab70726a70d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"data\": {\n \"type\": \"line_items\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"external_promotions\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"data\": {\n \"type\": \"gift_cards\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId" ], "variable": [ { "id": "8b637650-f13b-4611-b693-f89f346dd1ce", "key": "notificationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a notification" }, "response": [ { "id": "c7f88cd6-c59f-4baa-9e94-ae85ffcae620", "name": "The updated notification object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"data\": {\n \"type\": \"line_items\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"external_promotions\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"data\": {\n \"type\": \"gift_cards\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId" ], "variable": [ { "key": "notificationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifiable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c7f88cd6-c59f-4baa-9e94-ae85ffcae620" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-10714d2e-f41a-49cc-90f0-ab70726a70d5" }, { "name": "Delete a notification", "id": "d44a5d1e-08f0-4161-9245-599c98e95bf0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId" ], "variable": [ { "id": "5559f0c5-1c26-48b0-bdfe-46aa6fe2cc2f", "key": "notificationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a notification" }, "response": [ { "id": "c7ade4e2-f6cd-4590-aea1-2d9bfe099607", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/notifications/:notificationId", "host": [ "{{baseUrl}}" ], "path": [ "notifications", ":notificationId" ], "variable": [ { "key": "notificationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c7ade4e2-f6cd-4590-aea1-2d9bfe099607" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d44a5d1e-08f0-4161-9245-599c98e95bf0" } ], "id": "a39b7dba-9326-40d0-9f98-46a7766cb447", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a39b7dba-9326-40d0-9f98-46a7766cb447" }, { "name": "List all notifications", "id": "f69dac02-8f3e-4425-bd49-2b79a9445970", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] }, "description": "List all notifications" }, "response": [ { "id": "24342d63-2179-456b-af29-3ab8ffb59a93", "name": "A list of notification objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifiable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifiable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-24342d63-2179-456b-af29-3ab8ffb59a93" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f69dac02-8f3e-4425-bd49-2b79a9445970" }, { "name": "Create a notification", "id": "1c2fa171-5f80-4b45-944e-21f2fe70ecb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"notifications\",\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"data\": {\n \"type\": \"line_items\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"discount_engine_items\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"data\": {\n \"type\": \"gift_cards\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] }, "description": "Create a notification" }, "response": [ { "id": "1ce0171a-0951-41fc-856c-d13f2aa67767", "name": "The created notification object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"notifications\",\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"data\": {\n \"type\": \"line_items\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"_external_price\": \"\",\n \"currency_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"options_amount_cents\": \"\",\n \"options_amount_float\": \"\",\n \"formatted_options_amount\": \"\",\n \"discount_cents\": \"\",\n \"discount_float\": \"\",\n \"formatted_discount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"tax_amount_cents\": \"\",\n \"tax_amount_float\": \"\",\n \"formatted_tax_amount\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"discount_breakdown\": {},\n \"tax_rate\": \"\",\n \"tax_breakdown\": {},\n \"item_type\": \"discount_engine_items\",\n \"frequency\": \"\",\n \"coupon_code\": \"\",\n \"rule_outcomes\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\"\n }\n },\n \"gift_card\": {\n \"data\": {\n \"type\": \"gift_cards\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"notifications\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"flash\": \"\",\n \"body\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"notifiable\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifiable\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1ce0171a-0951-41fc-856c-d13f2aa67767" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1c2fa171-5f80-4b45-944e-21f2fe70ecb0" } ], "id": "e85fbf16-9535-4e4b-9338-234742283a53", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e85fbf16-9535-4e4b-9338-234742283a53" }, { "name": "order_amount_promotion_rules", "item": [ { "name": "{orderAmountPromotionRuleId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the order amount promotion rule", "id": "7b7a28fe-9c3c-481e-9cc6-a154c98bdcca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId", "event_stores" ], "variable": [ { "id": "12b9fd06-7c83-4563-bc3c-ea6e8cdee547", "key": "orderAmountPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the order amount promotion rule" }, "response": [ { "id": "a3504e9b-c7b1-4d49-8342-74fa19b9f0b7", "name": "The event_stores associated to the order amount promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId", "event_stores" ], "variable": [ { "key": "orderAmountPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a3504e9b-c7b1-4d49-8342-74fa19b9f0b7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7b7a28fe-9c3c-481e-9cc6-a154c98bdcca" } ], "id": "39680d5a-803b-4e7f-a415-b8471de6a4ea", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-39680d5a-803b-4e7f-a415-b8471de6a4ea" }, { "name": "Retrieve an order amount promotion rule", "id": "818972d5-a24f-4249-a4d1-67d381af951f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId" ], "variable": [ { "id": "0c020e02-3429-42a7-97f2-34ad2914e897", "key": "orderAmountPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an order amount promotion rule" }, "response": [ { "id": "742b5fe8-83d7-4fc1-a2e5-6b41fcbd079d", "name": "The order amount promotion rule object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId" ], "variable": [ { "key": "orderAmountPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_amount_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"order_amount_float\": \"\",\n \"formatted_order_amount\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-742b5fe8-83d7-4fc1-a2e5-6b41fcbd079d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-818972d5-a24f-4249-a4d1-67d381af951f" }, { "name": "Update an order amount promotion rule", "id": "89641af0-7acf-478b-a3db-df203e3e3bac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId" ], "variable": [ { "id": "a22590dd-14fe-45ae-8574-5dea53b28dcf", "key": "orderAmountPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an order amount promotion rule" }, "response": [ { "id": "0a69d7ee-a833-42fe-b020-1f1906b50762", "name": "The updated order amount promotion rule object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId" ], "variable": [ { "key": "orderAmountPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_amount_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"order_amount_float\": \"\",\n \"formatted_order_amount\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0a69d7ee-a833-42fe-b020-1f1906b50762" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-89641af0-7acf-478b-a3db-df203e3e3bac" }, { "name": "Delete an order amount promotion rule", "id": "62597714-1246-4a1a-aa2c-d655312c4ce5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId" ], "variable": [ { "id": "68231b82-2de4-4a61-be83-b754ef4eecb9", "key": "orderAmountPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an order amount promotion rule" }, "response": [ { "id": "f8e544cd-fc41-4dae-85bf-8c7b7993ad1a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules/:orderAmountPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules", ":orderAmountPromotionRuleId" ], "variable": [ { "key": "orderAmountPromotionRuleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f8e544cd-fc41-4dae-85bf-8c7b7993ad1a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-62597714-1246-4a1a-aa2c-d655312c4ce5" } ], "id": "af4d79ce-eabc-4e17-bad2-27eb4b78196b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-af4d79ce-eabc-4e17-bad2-27eb4b78196b" }, { "name": "List all order amount promotion rules", "id": "e68556cb-3420-4ca8-8e78-92e3b7bdff0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules" ] }, "description": "List all order amount promotion rules" }, "response": [ { "id": "4d3fac78-bad4-4221-a002-9d18577c0dfc", "name": "A list of order amount promotion rule objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"order_amount_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"custom_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"order_amount_float\": \"\",\n \"formatted_order_amount\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"order_amount_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"sku_list_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"order_amount_float\": \"\",\n \"formatted_order_amount\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4d3fac78-bad4-4221-a002-9d18577c0dfc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e68556cb-3420-4ca8-8e78-92e3b7bdff0a" }, { "name": "Create an order amount promotion rule", "id": "d4ce1238-b506-481a-acf0-639dd975cf57", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules" ] }, "description": "Create an order amount promotion rule" }, "response": [ { "id": "c5341f74-f5ec-47eb-94b2-92758753752c", "name": "The created order amount promotion rule object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_gift_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_amount_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "order_amount_promotion_rules" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_amount_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"order_amount_cents\": \"\",\n \"order_amount_float\": \"\",\n \"formatted_order_amount\": \"\",\n \"use_subtotal\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c5341f74-f5ec-47eb-94b2-92758753752c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d4ce1238-b506-481a-acf0-639dd975cf57" } ], "id": "32ab69ff-2cc0-405d-a2ee-31969955645b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-32ab69ff-2cc0-405d-a2ee-31969955645b" }, { "name": "order_copies", "item": [ { "name": "{orderCopyId}", "item": [ { "name": "source_order", "item": [ { "name": "Retrieve the source order associated to the order copy", "id": "83841bc9-b39e-44c7-b9ac-c3a21d1caba4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "source_order" ], "variable": [ { "id": "f7584c8a-f58c-4308-8496-c0afaaccdaa7", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the source order associated to the order copy" }, "response": [ { "id": "327e1e51-e7f7-46ab-9028-ab95525cd7f3", "name": "The source_order associated to the order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "source_order" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-327e1e51-e7f7-46ab-9028-ab95525cd7f3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83841bc9-b39e-44c7-b9ac-c3a21d1caba4" } ], "id": "d568a370-1d79-495f-917a-a5dab219fac2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d568a370-1d79-495f-917a-a5dab219fac2" }, { "name": "target_order", "item": [ { "name": "Retrieve the target order associated to the order copy", "id": "fbf02f36-af3d-435c-a3ce-1aa9b5cb6ddf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/target_order", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "target_order" ], "variable": [ { "id": "7dcf1512-4d24-436f-bee7-af2f777c9a53", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the target order associated to the order copy" }, "response": [ { "id": "d593ad45-d669-498f-97ba-145bcfffb029", "name": "The target_order associated to the order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/target_order", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "target_order" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d593ad45-d669-498f-97ba-145bcfffb029" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fbf02f36-af3d-435c-a3ce-1aa9b5cb6ddf" } ], "id": "2aae8360-4ab0-4608-80d9-79b0e56782dd", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2aae8360-4ab0-4608-80d9-79b0e56782dd" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the order copy", "id": "fe3022ec-e72e-4d1d-8bee-46b4f55f534c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/events", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "events" ], "variable": [ { "id": "beeeb87b-9e8f-442d-bd3b-aa1bf5019811", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the order copy" }, "response": [ { "id": "c383d36c-aec9-4e7e-bfaf-7cb44978f94c", "name": "The events associated to the order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/events", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "events" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c383d36c-aec9-4e7e-bfaf-7cb44978f94c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fe3022ec-e72e-4d1d-8bee-46b4f55f534c" } ], "id": "b2f937a8-d042-4a59-aed7-4c9598f71fd2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b2f937a8-d042-4a59-aed7-4c9598f71fd2" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the order copy", "id": "2d5d7467-c30e-432b-8c5c-6141dba455cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "event_stores" ], "variable": [ { "id": "37c14abd-0730-49b1-98a9-cc8057bb5ccf", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the order copy" }, "response": [ { "id": "c0a8e3c2-3d12-4680-9da6-8cb3fd6f199d", "name": "The event_stores associated to the order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "event_stores" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c0a8e3c2-3d12-4680-9da6-8cb3fd6f199d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d5d7467-c30e-432b-8c5c-6141dba455cc" } ], "id": "da473054-104e-4f8c-8fbe-9ad6923ecd72", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-da473054-104e-4f8c-8fbe-9ad6923ecd72" }, { "name": "order_subscription", "item": [ { "name": "Retrieve the order subscription associated to the order copy", "id": "41ac378e-3af8-4bb2-bcf6-cbd25bc36dcc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "order_subscription" ], "variable": [ { "id": "c22211f0-0569-4ff0-b5ab-8e9bdc4a5e05", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscription associated to the order copy" }, "response": [ { "id": "f4ff440c-70ee-4245-b4b5-584783a4998f", "name": "The order_subscription associated to the order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId", "order_subscription" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f4ff440c-70ee-4245-b4b5-584783a4998f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-41ac378e-3af8-4bb2-bcf6-cbd25bc36dcc" } ], "id": "28c947f0-d7fd-43fa-acf1-1cc6a89e235d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-28c947f0-d7fd-43fa-acf1-1cc6a89e235d" }, { "name": "Retrieve an order copy", "id": "3724d57d-4210-4a75-98bd-a9c58dd27620", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId" ], "variable": [ { "id": "ea86c7fd-f835-4079-a33a-58e05685347c", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an order copy" }, "response": [ { "id": "00338db1-b8a0-447d-8c76-69becb491d52", "name": "The order copy object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"failed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-00338db1-b8a0-447d-8c76-69becb491d52" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3724d57d-4210-4a75-98bd-a9c58dd27620" }, { "name": "Update an order copy", "id": "9e914631-bebe-4931-9c4f-6ac315f395b9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId" ], "variable": [ { "id": "701c8f5f-e9e0-483c-b72d-f230f557edda", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an order copy" }, "response": [ { "id": "1154e40c-bac7-49df-b66b-29bf70098420", "name": "The updated order copy object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"failed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1154e40c-bac7-49df-b66b-29bf70098420" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9e914631-bebe-4931-9c4f-6ac315f395b9" }, { "name": "Delete an order copy", "id": "0cf21aeb-9504-47c6-a08e-36867e5be70f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId" ], "variable": [ { "id": "227ef62b-6560-4a72-ab2d-03457b83ca60", "key": "orderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an order copy" }, "response": [ { "id": "00ff672d-357e-4ce3-b8f1-68a82529b440", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies/:orderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "order_copies", ":orderCopyId" ], "variable": [ { "key": "orderCopyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-00ff672d-357e-4ce3-b8f1-68a82529b440" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0cf21aeb-9504-47c6-a08e-36867e5be70f" } ], "id": "bad76846-94c6-4ca5-ad51-a18902cf1df7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bad76846-94c6-4ca5-ad51-a18902cf1df7" }, { "name": "List all order copies", "id": "dfd23f93-aecb-4d14-a413-7ea2906a803b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_copies", "host": [ "{{baseUrl}}" ], "path": [ "order_copies" ] }, "description": "List all order copies" }, "response": [ { "id": "bd65229e-7e80-4343-98c8-8ade0b09f0ed", "name": "A list of order copy objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_copies", "host": [ "{{baseUrl}}" ], "path": [ "order_copies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"recurring_order_copies\",\n \"status\": \"aborted\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"aborted\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bd65229e-7e80-4343-98c8-8ade0b09f0ed" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dfd23f93-aecb-4d14-a413-7ea2906a803b" }, { "name": "Create an order copy", "id": "77d98dbd-a318-4488-9cf9-1dcb6281a55a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_copies\",\n \"attributes\": {\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_copies", "host": [ "{{baseUrl}}" ], "path": [ "order_copies" ] }, "description": "Create an order copy" }, "response": [ { "id": "ee694c1d-a544-4905-ba62-e193dd8666b9", "name": "The created order copy object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_copies\",\n \"attributes\": {\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_copies", "host": [ "{{baseUrl}}" ], "path": [ "order_copies" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"failed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"cancel_source_order\": \"\",\n \"apply_promotions\": \"\",\n \"skip_errors\": \"\",\n \"ignore_invalid_coupon\": \"\"\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ee694c1d-a544-4905-ba62-e193dd8666b9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-77d98dbd-a318-4488-9cf9-1dcb6281a55a" } ], "id": "f3f77a08-f652-49a9-a00b-ccea0acf8ab1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f3f77a08-f652-49a9-a00b-ccea0acf8ab1" }, { "name": "order_factories", "item": [ { "name": "{orderFactoryId}", "item": [ { "name": "source_order", "item": [ { "name": "Retrieve the source order associated to the order factory", "id": "ae753940-33df-4041-8dce-307fe6e2940b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "source_order" ], "variable": [ { "id": "6eabdb5c-3f2b-45d1-a59c-2f0984e7afda", "key": "orderFactoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the source order associated to the order factory" }, "response": [ { "id": "a34609d6-3be6-4b2d-ab63-5ae48dc00241", "name": "The source_order associated to the order factory", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "source_order" ], "variable": [ { "key": "orderFactoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a34609d6-3be6-4b2d-ab63-5ae48dc00241" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ae753940-33df-4041-8dce-307fe6e2940b" } ], "id": "d1cc2544-a86e-47b2-841f-791468b5a9c8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d1cc2544-a86e-47b2-841f-791468b5a9c8" }, { "name": "target_order", "item": [ { "name": "Retrieve the target order associated to the order factory", "id": "e50880bc-3abc-4934-b38b-741ba491aa87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/target_order", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "target_order" ], "variable": [ { "id": "215a8aa6-9e27-4002-a937-6ebd4f2288b7", "key": "orderFactoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the target order associated to the order factory" }, "response": [ { "id": "ae69c775-1401-49e0-849b-1a9ee47f7721", "name": "The target_order associated to the order factory", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/target_order", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "target_order" ], "variable": [ { "key": "orderFactoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ae69c775-1401-49e0-849b-1a9ee47f7721" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e50880bc-3abc-4934-b38b-741ba491aa87" } ], "id": "229f8f53-437f-4217-b99a-044962448a79", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-229f8f53-437f-4217-b99a-044962448a79" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the order factory", "id": "202699d8-794c-49ed-abd5-b60cb1b63148", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/events", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "events" ], "variable": [ { "id": "b744affc-63b6-4580-b563-eef5035ccee5", "key": "orderFactoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the order factory" }, "response": [ { "id": "cd57e993-0c83-4f0b-bcf5-45be035ab151", "name": "The events associated to the order factory", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/events", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "events" ], "variable": [ { "key": "orderFactoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd57e993-0c83-4f0b-bcf5-45be035ab151" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-202699d8-794c-49ed-abd5-b60cb1b63148" } ], "id": "ce2e468a-b05e-4ca3-8783-5f90c45dbb11", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ce2e468a-b05e-4ca3-8783-5f90c45dbb11" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the order factory", "id": "e01a9b77-6db0-406b-a81a-93358e955d05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "event_stores" ], "variable": [ { "id": "2a3a4445-6b08-4f96-a0f9-8ecb19065a9b", "key": "orderFactoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the order factory" }, "response": [ { "id": "fbd8a028-dae7-4a88-867e-1aa9bcad45cc", "name": "The event_stores associated to the order factory", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId", "event_stores" ], "variable": [ { "key": "orderFactoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fbd8a028-dae7-4a88-867e-1aa9bcad45cc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e01a9b77-6db0-406b-a81a-93358e955d05" } ], "id": "fb2d4285-d139-452a-9305-ff19b958133e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fb2d4285-d139-452a-9305-ff19b958133e" }, { "name": "Retrieve an order factory", "id": "5861d41f-c676-468b-b597-bb3f6c24380c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId" ], "variable": [ { "id": "4c3788b7-b4b8-4be7-a88e-d6a17ca34d96", "key": "orderFactoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an order factory" }, "response": [ { "id": "f7e8ce13-1fbf-4c1b-8813-3ee0c43f3146", "name": "The order factory object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_factories/:orderFactoryId", "host": [ "{{baseUrl}}" ], "path": [ "order_factories", ":orderFactoryId" ], "variable": [ { "key": "orderFactoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_factories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"recurring_order_copies\",\n \"status\": \"aborted\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f7e8ce13-1fbf-4c1b-8813-3ee0c43f3146" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5861d41f-c676-468b-b597-bb3f6c24380c" } ], "id": "ff3b8ac3-f8b4-4ae6-a97d-06dad4dfe5b6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ff3b8ac3-f8b4-4ae6-a97d-06dad4dfe5b6" }, { "name": "List all order factories", "id": "75c3ab7d-863d-45e8-a4d7-222307cfd336", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_factories", "host": [ "{{baseUrl}}" ], "path": [ "order_factories" ] }, "description": "List all order factories" }, "response": [ { "id": "ac77511e-269f-4f42-b905-82b6c9d43ac2", "name": "A list of order factory objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_factories", "host": [ "{{baseUrl}}" ], "path": [ "order_factories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"order_factories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"order_factories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"recurring_order_copies\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ac77511e-269f-4f42-b905-82b6c9d43ac2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-75c3ab7d-863d-45e8-a4d7-222307cfd336" } ], "id": "2e4d89de-adc8-464c-b219-31bb41cfe25d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2e4d89de-adc8-464c-b219-31bb41cfe25d" }, { "name": "order_subscription_items", "item": [ { "name": "{orderSubscriptionItemId}", "item": [ { "name": "order_subscription", "item": [ { "name": "Retrieve the order subscription associated to the order subscription item", "id": "d93343dd-2bbf-4cc5-8d8c-0ba4f88bac57", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId", "order_subscription" ], "variable": [ { "id": "77b062a7-df25-4523-939c-0f72f15bf85a", "key": "orderSubscriptionItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscription associated to the order subscription item" }, "response": [ { "id": "dcdd7385-e782-43ed-9a6c-dbf4ba971506", "name": "The order_subscription associated to the order subscription item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId", "order_subscription" ], "variable": [ { "key": "orderSubscriptionItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dcdd7385-e782-43ed-9a6c-dbf4ba971506" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d93343dd-2bbf-4cc5-8d8c-0ba4f88bac57" } ], "id": "5fe310cb-2706-45a9-84c1-4a0dc2896cc1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5fe310cb-2706-45a9-84c1-4a0dc2896cc1" }, { "name": "source_line_item", "item": [ { "name": "Retrieve the source line item associated to the order subscription item", "id": "d78f5d85-c421-4c72-a55e-00160756bb70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId/source_line_item", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId", "source_line_item" ], "variable": [ { "id": "5379a75b-4256-4d5c-aa08-662588010b2f", "key": "orderSubscriptionItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the source line item associated to the order subscription item" }, "response": [ { "id": "82f29acd-ac94-4910-aeab-6aaa4a1c69e3", "name": "The source_line_item associated to the order subscription item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId/source_line_item", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId", "source_line_item" ], "variable": [ { "key": "orderSubscriptionItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-82f29acd-ac94-4910-aeab-6aaa4a1c69e3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d78f5d85-c421-4c72-a55e-00160756bb70" } ], "id": "b3d22028-9337-4167-9d40-e9473011ce7b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b3d22028-9337-4167-9d40-e9473011ce7b" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the order subscription item", "id": "11cfad0b-b017-44c8-a804-11b2b9b532e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId", "event_stores" ], "variable": [ { "id": "24f0f50d-e9f2-4e2a-8a76-dcd4291bacfd", "key": "orderSubscriptionItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the order subscription item" }, "response": [ { "id": "88637de8-1d17-48b0-acdd-5e4a6f52e294", "name": "The event_stores associated to the order subscription item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId", "event_stores" ], "variable": [ { "key": "orderSubscriptionItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-88637de8-1d17-48b0-acdd-5e4a6f52e294" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-11cfad0b-b017-44c8-a804-11b2b9b532e3" } ], "id": "d2dfa59c-8b0b-4e7d-aeeb-5c37a144e321", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d2dfa59c-8b0b-4e7d-aeeb-5c37a144e321" }, { "name": "Retrieve an order subscription item", "id": "63dd9711-6236-490d-b466-ad2a0148d82e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId" ], "variable": [ { "id": "5ffe7ae2-7398-4280-b19f-3b0b8bf53222", "key": "orderSubscriptionItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an order subscription item" }, "response": [ { "id": "3c594d46-621f-461c-baff-f4272127ba38", "name": "The order subscription item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId" ], "variable": [ { "key": "orderSubscriptionItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_subscription_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"source_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3c594d46-621f-461c-baff-f4272127ba38" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-63dd9711-6236-490d-b466-ad2a0148d82e" }, { "name": "Update an order subscription item", "id": "5bc61c6a-758f-4985-a16d-c77e5411c198", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId" ], "variable": [ { "id": "680a6a4e-01e6-41d7-a379-9af6e136c9fc", "key": "orderSubscriptionItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an order subscription item" }, "response": [ { "id": "506be966-4ddf-4dd3-b64c-eb7b372dc6f0", "name": "The updated order subscription item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId" ], "variable": [ { "key": "orderSubscriptionItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_subscription_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"source_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-506be966-4ddf-4dd3-b64c-eb7b372dc6f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5bc61c6a-758f-4985-a16d-c77e5411c198" }, { "name": "Delete an order subscription item", "id": "5d89f9e7-a244-48e2-8d4d-c2ad53a25778", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId" ], "variable": [ { "id": "35fa6075-f519-4c49-abce-866021d50c8f", "key": "orderSubscriptionItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an order subscription item" }, "response": [ { "id": "faa9fb7b-3dba-4e4e-b4e5-e58c427fb271", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscription_items/:orderSubscriptionItemId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items", ":orderSubscriptionItemId" ], "variable": [ { "key": "orderSubscriptionItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-faa9fb7b-3dba-4e4e-b4e5-e58c427fb271" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5d89f9e7-a244-48e2-8d4d-c2ad53a25778" } ], "id": "ea0cff53-1f17-4dcc-8b11-a5360594e208", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ea0cff53-1f17-4dcc-8b11-a5360594e208" }, { "name": "List all order subscription items", "id": "7d3e5d48-6357-49aa-9d45-b73ba85c3928", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items" ] }, "description": "List all order subscription items" }, "response": [ { "id": "484b85a5-d3d9-4fc5-8be9-2c905b5731b2", "name": "A list of order subscription item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"order_subscription_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"source_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"order_subscription_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"source_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-484b85a5-d3d9-4fc5-8be9-2c905b5731b2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7d3e5d48-6357-49aa-9d45-b73ba85c3928" }, { "name": "Create an order subscription item", "id": "182f74ca-b23c-4c65-8e9c-3392a085fddb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items" ] }, "description": "Create an order subscription item" }, "response": [ { "id": "635dff82-cdac-496c-a80f-784918cd5d47", "name": "The created order subscription item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"unit_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"data\": {\n \"type\": \"adjustments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "order_subscription_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_subscription_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"unit_amount_cents\": \"\",\n \"unit_amount_float\": \"\",\n \"formatted_unit_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"bundle\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundle\",\n \"id\": \"\"\n }\n },\n \"adjustment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"adjustment\",\n \"id\": \"\"\n }\n },\n \"source_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-635dff82-cdac-496c-a80f-784918cd5d47" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-182f74ca-b23c-4c65-8e9c-3392a085fddb" } ], "id": "67458bb3-dd11-4767-92de-8436c87a84ae", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-67458bb3-dd11-4767-92de-8436c87a84ae" }, { "name": "order_subscriptions", "item": [ { "name": "{orderSubscriptionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the order subscription", "id": "d9a3f050-dea8-48f6-8207-7844a5b965e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/market", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "market" ], "variable": [ { "id": "aae88bbc-5b5b-4f6c-b503-3abadcd20d5a", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the order subscription" }, "response": [ { "id": "3f32587d-f409-4ca3-ab7b-dd352a376055", "name": "The market associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/market", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "market" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3f32587d-f409-4ca3-ab7b-dd352a376055" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9a3f050-dea8-48f6-8207-7844a5b965e9" } ], "id": "f7a9f976-ce38-4136-8200-420fc1b291a0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f7a9f976-ce38-4136-8200-420fc1b291a0" }, { "name": "subscription_model", "item": [ { "name": "Retrieve the subscription model associated to the order subscription", "id": "4d55fb37-f3b5-4c18-b602-6cb664d657d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/subscription_model", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "subscription_model" ], "variable": [ { "id": "6d8b3ef8-5588-44e2-a552-5fffc37ef4a1", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the subscription model associated to the order subscription" }, "response": [ { "id": "c0ae68ec-8d8d-4d7d-84a9-0680c42357ab", "name": "The subscription_model associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/subscription_model", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "subscription_model" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c0ae68ec-8d8d-4d7d-84a9-0680c42357ab" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4d55fb37-f3b5-4c18-b602-6cb664d657d0" } ], "id": "8d00278b-3f66-43d0-8e3d-661076e3197b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8d00278b-3f66-43d0-8e3d-661076e3197b" }, { "name": "source_order", "item": [ { "name": "Retrieve the source order associated to the order subscription", "id": "e89a14a1-40fa-4e19-9ee5-4f29e14d424a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "source_order" ], "variable": [ { "id": "fb20b8e7-94c3-4543-9ba4-3715c336884e", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the source order associated to the order subscription" }, "response": [ { "id": "8656e7fe-5be5-41ca-a2d1-3686f59d8706", "name": "The source_order associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "source_order" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8656e7fe-5be5-41ca-a2d1-3686f59d8706" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e89a14a1-40fa-4e19-9ee5-4f29e14d424a" } ], "id": "7cb947c3-2afd-49e6-9d56-cc4e46df4417", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7cb947c3-2afd-49e6-9d56-cc4e46df4417" }, { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the order subscription", "id": "86a57ef9-bedf-4633-9110-9172cc06c8ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/customer", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "customer" ], "variable": [ { "id": "c28628e1-83c8-41cf-83ad-e7f802b42274", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the order subscription" }, "response": [ { "id": "fb2fe01f-3751-4eac-81f4-be5cc9ec35d2", "name": "The customer associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/customer", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "customer" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fb2fe01f-3751-4eac-81f4-be5cc9ec35d2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-86a57ef9-bedf-4633-9110-9172cc06c8ab" } ], "id": "86e98aa0-089e-4e3b-a33c-96c13f4ef42c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-86e98aa0-089e-4e3b-a33c-96c13f4ef42c" }, { "name": "customer_payment_source", "item": [ { "name": "Retrieve the customer payment source associated to the order subscription", "id": "6563a157-1299-4eaf-a5ed-4956e3a920f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/customer_payment_source", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "customer_payment_source" ], "variable": [ { "id": "84e67382-d4e9-4ee0-a1f1-3766c630ab28", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer payment source associated to the order subscription" }, "response": [ { "id": "60044633-b1f9-4ce7-af70-1a178bab697b", "name": "The customer_payment_source associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/customer_payment_source", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "customer_payment_source" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-60044633-b1f9-4ce7-af70-1a178bab697b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6563a157-1299-4eaf-a5ed-4956e3a920f2" } ], "id": "69d8d825-a255-46a6-9f77-ba735ce47c8c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-69d8d825-a255-46a6-9f77-ba735ce47c8c" }, { "name": "order_subscription_items", "item": [ { "name": "Retrieve the order subscription items associated to the order subscription", "id": "95022f75-f018-408c-bcbb-52316c32f695", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/order_subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "order_subscription_items" ], "variable": [ { "id": "9c0c5c6c-faab-45dd-a992-3a683f6e25a8", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscription items associated to the order subscription" }, "response": [ { "id": "0f1ea6be-b4df-4432-934a-7321eca84641", "name": "The order_subscription_items associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/order_subscription_items", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "order_subscription_items" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0f1ea6be-b4df-4432-934a-7321eca84641" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-95022f75-f018-408c-bcbb-52316c32f695" } ], "id": "eeba7a47-91a0-4cd9-a8b4-43317fac1b7d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-eeba7a47-91a0-4cd9-a8b4-43317fac1b7d" }, { "name": "order_factories", "item": [ { "name": "Retrieve the order factories associated to the order subscription", "id": "475f8778-901d-4045-b109-67583c249030", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/order_factories", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "order_factories" ], "variable": [ { "id": "e80f2fc4-ce94-450e-b202-9c83264aecc7", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order factories associated to the order subscription" }, "response": [ { "id": "0ba94b3c-0383-4d03-b31d-56b3b453c568", "name": "The order_factories associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/order_factories", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "order_factories" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0ba94b3c-0383-4d03-b31d-56b3b453c568" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-475f8778-901d-4045-b109-67583c249030" } ], "id": "ddb4c20b-6689-4461-bc90-a0e7846857e1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ddb4c20b-6689-4461-bc90-a0e7846857e1" }, { "name": "recurring_order_copies", "item": [ { "name": "Retrieve the recurring order copies associated to the order subscription", "id": "b737696e-7775-4c02-9d6b-27a032bc3dd0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "recurring_order_copies" ], "variable": [ { "id": "91fb9adb-73d5-46be-8bc6-0cc9be732451", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the recurring order copies associated to the order subscription" }, "response": [ { "id": "d0a17ed3-91b8-4d54-92af-6827c29a9db9", "name": "The recurring_order_copies associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "recurring_order_copies" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d0a17ed3-91b8-4d54-92af-6827c29a9db9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b737696e-7775-4c02-9d6b-27a032bc3dd0" } ], "id": "39d607af-c1a0-4964-81ab-7c10ae732289", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-39d607af-c1a0-4964-81ab-7c10ae732289" }, { "name": "orders", "item": [ { "name": "Retrieve the orders associated to the order subscription", "id": "d378795f-dca9-47bc-900a-c400382a6731", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/orders", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "orders" ], "variable": [ { "id": "5fa2aca8-2db6-4a4c-a904-ee534f5a2c54", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the orders associated to the order subscription" }, "response": [ { "id": "a21b0cc4-09b6-43fd-912b-5dce69517d03", "name": "The orders associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/orders", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "orders" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a21b0cc4-09b6-43fd-912b-5dce69517d03" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d378795f-dca9-47bc-900a-c400382a6731" } ], "id": "7ae31e8c-de33-4a1b-91e9-d8248cee6b36", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7ae31e8c-de33-4a1b-91e9-d8248cee6b36" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the order subscription", "id": "42324df7-5e26-44d4-a69d-bdf307c6df96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "events" ], "variable": [ { "id": "3858d008-e24f-4737-8dea-091460c6bbad", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the order subscription" }, "response": [ { "id": "7d7e2524-cb09-4657-9c8b-76d0da248d1c", "name": "The events associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "events" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7d7e2524-cb09-4657-9c8b-76d0da248d1c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-42324df7-5e26-44d4-a69d-bdf307c6df96" } ], "id": "1b90f7c0-cc64-4ba6-bfbe-3775a2fab223", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1b90f7c0-cc64-4ba6-bfbe-3775a2fab223" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the order subscription", "id": "fc07b41f-45e7-4b6b-90e0-af1d14d7a9eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "tags" ], "variable": [ { "id": "2317fe0f-3279-4815-99fa-c5188a23324e", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the order subscription" }, "response": [ { "id": "3e6b8a3e-298b-4fb3-8d95-3a7e2715b060", "name": "The tags associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "tags" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3e6b8a3e-298b-4fb3-8d95-3a7e2715b060" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fc07b41f-45e7-4b6b-90e0-af1d14d7a9eb" } ], "id": "443eebda-e450-49a0-8ae3-08cf41ecf4b2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-443eebda-e450-49a0-8ae3-08cf41ecf4b2" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the order subscription", "id": "d75a814a-1d7b-42c0-b49c-b3f5433506b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "event_stores" ], "variable": [ { "id": "c4e86d8a-2d8f-403e-87e3-2e495029d293", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the order subscription" }, "response": [ { "id": "3e31d162-c554-40bf-9b6d-070135e250a1", "name": "The event_stores associated to the order subscription", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId", "event_stores" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3e31d162-c554-40bf-9b6d-070135e250a1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d75a814a-1d7b-42c0-b49c-b3f5433506b8" } ], "id": "522b308d-9f91-45a8-85a1-ca6eaf3b4a0a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-522b308d-9f91-45a8-85a1-ca6eaf3b4a0a" }, { "name": "Retrieve an order subscription", "id": "2e485ea4-9ce3-47cf-aabc-3f6546dfac3f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId" ], "variable": [ { "id": "47ba4759-06d6-4a5f-8503-894fe5c1b0b1", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an order subscription" }, "response": [ { "id": "ca485e40-5c77-4282-884c-f30bd38c26da", "name": "The order subscription object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"active\",\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"customer_email\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"occurrencies\": \"\",\n \"errors_count\": \"\",\n \"succeeded_on_last_run\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"customer_payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_source\",\n \"id\": \"\"\n }\n },\n \"order_subscription_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ca485e40-5c77-4282-884c-f30bd38c26da" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e485ea4-9ce3-47cf-aabc-3f6546dfac3f" }, { "name": "Update an order subscription", "id": "9d6fd7b1-e2ff-4a6c-a694-27744de8d19c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\",\n \"attributes\": {\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"expires_at\": \"\",\n \"next_run_at\": \"\",\n \"_activate\": \"\",\n \"_deactivate\": \"\",\n \"_cancel\": \"\",\n \"_convert\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer_payment_source\": {\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId" ], "variable": [ { "id": "f2605182-32c5-4366-b098-8ad21e787ae0", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an order subscription" }, "response": [ { "id": "dfb1a763-5435-4674-8d78-aab2a082749f", "name": "The updated order subscription object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\",\n \"attributes\": {\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"expires_at\": \"\",\n \"next_run_at\": \"\",\n \"_activate\": \"\",\n \"_deactivate\": \"\",\n \"_cancel\": \"\",\n \"_convert\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer_payment_source\": {\n \"data\": {\n \"type\": \"customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"active\",\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"customer_email\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"occurrencies\": \"\",\n \"errors_count\": \"\",\n \"succeeded_on_last_run\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"customer_payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_source\",\n \"id\": \"\"\n }\n },\n \"order_subscription_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dfb1a763-5435-4674-8d78-aab2a082749f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9d6fd7b1-e2ff-4a6c-a694-27744de8d19c" }, { "name": "Delete an order subscription", "id": "7083bec0-8e3e-4214-9235-b8b3c7c7dc2b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId" ], "variable": [ { "id": "f6a6ebac-ae64-45f0-b0f1-c01760f5db53", "key": "orderSubscriptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an order subscription" }, "response": [ { "id": "22e0069f-e0d3-4720-963c-7352ca99d30b", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions/:orderSubscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions", ":orderSubscriptionId" ], "variable": [ { "key": "orderSubscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-22e0069f-e0d3-4720-963c-7352ca99d30b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7083bec0-8e3e-4214-9235-b8b3c7c7dc2b" } ], "id": "d9ca604c-cee9-47de-93d4-ea7977b70edf", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d9ca604c-cee9-47de-93d4-ea7977b70edf" }, { "name": "List all order subscriptions", "id": "1f35154c-15f1-47ea-ae6b-396e459f3c9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions" ] }, "description": "List all order subscriptions" }, "response": [ { "id": "e327abc6-ceb5-4102-afba-c0b22d3a58a2", "name": "A list of order subscription objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"order_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"draft\",\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"customer_email\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"occurrencies\": \"\",\n \"errors_count\": \"\",\n \"succeeded_on_last_run\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"customer_payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_source\",\n \"id\": \"\"\n }\n },\n \"order_subscription_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"order_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"cancelled\",\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"customer_email\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"occurrencies\": \"\",\n \"errors_count\": \"\",\n \"succeeded_on_last_run\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"customer_payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_source\",\n \"id\": \"\"\n }\n },\n \"order_subscription_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e327abc6-ceb5-4102-afba-c0b22d3a58a2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1f35154c-15f1-47ea-ae6b-396e459f3c9d" }, { "name": "Create an order subscription", "id": "f67212dd-e394-4077-8152-f0139b1aabd8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"attributes\": {\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions" ] }, "description": "Create an order subscription" }, "response": [ { "id": "6c46604d-aca6-486d-8d94-23a1e458b04d", "name": "The created order subscription object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"attributes\": {\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "order_subscriptions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"order_subscriptions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"active\",\n \"frequency\": \"\",\n \"activate_by_source_order\": \"\",\n \"place_target_order\": \"\",\n \"renewal_alert_period\": \"\",\n \"customer_email\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"last_run_at\": \"\",\n \"next_run_at\": \"\",\n \"occurrencies\": \"\",\n \"errors_count\": \"\",\n \"succeeded_on_last_run\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"subscription_model\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"subscription_model\",\n \"id\": \"\"\n }\n },\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"customer_payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer_payment_source\",\n \"id\": \"\"\n }\n },\n \"order_subscription_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription_items\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6c46604d-aca6-486d-8d94-23a1e458b04d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f67212dd-e394-4077-8152-f0139b1aabd8" } ], "id": "69b63ace-b961-45d3-9ecb-3ec8a23089be", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-69b63ace-b961-45d3-9ecb-3ec8a23089be" }, { "name": "orders", "item": [ { "name": "{orderId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the order", "id": "19fc7d06-4c1e-4440-9dec-2fe3a57abce1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/market", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "market" ], "variable": [ { "id": "1dd7c31a-1297-47d3-b34b-80dd8db3797b", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the order" }, "response": [ { "id": "e397e221-2aa2-4568-b153-5e76782d671b", "name": "The market associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/market", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "market" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e397e221-2aa2-4568-b153-5e76782d671b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19fc7d06-4c1e-4440-9dec-2fe3a57abce1" } ], "id": "25817c3c-5c31-4831-8d49-292f821f59ea", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-25817c3c-5c31-4831-8d49-292f821f59ea" }, { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the order", "id": "b8d22b51-53c7-4d79-a331-9d5cbe591d6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/customer", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "customer" ], "variable": [ { "id": "5c3c751d-eaca-438e-8d55-43a3ac6b257d", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the order" }, "response": [ { "id": "8dafdc0e-88ad-42d5-a575-894d0ada8a4f", "name": "The customer associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/customer", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "customer" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8dafdc0e-88ad-42d5-a575-894d0ada8a4f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b8d22b51-53c7-4d79-a331-9d5cbe591d6c" } ], "id": "0682c2ea-cedb-49fc-bb44-e7130b91899d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0682c2ea-cedb-49fc-bb44-e7130b91899d" }, { "name": "shipping_address", "item": [ { "name": "Retrieve the shipping address associated to the order", "id": "61d2be99-0c24-4cc1-8e7d-a0d7583f6ab3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/shipping_address", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "shipping_address" ], "variable": [ { "id": "7bf083bf-ecfd-48dc-a7fb-3ecd4eba3506", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping address associated to the order" }, "response": [ { "id": "db454587-1baf-43f1-9b49-63566888b733", "name": "The shipping_address associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/shipping_address", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "shipping_address" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-db454587-1baf-43f1-9b49-63566888b733" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-61d2be99-0c24-4cc1-8e7d-a0d7583f6ab3" } ], "id": "559ca3e0-f7b5-47e6-8aee-2ae7a1e43830", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-559ca3e0-f7b5-47e6-8aee-2ae7a1e43830" }, { "name": "billing_address", "item": [ { "name": "Retrieve the billing address associated to the order", "id": "4108887f-45f1-4a6b-9629-84370bbf4d4c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/billing_address", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "billing_address" ], "variable": [ { "id": "a1f6ad5d-7d55-40db-9673-547512cbd5a2", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the billing address associated to the order" }, "response": [ { "id": "8e18aebd-9b7f-4829-8853-363e03e72029", "name": "The billing_address associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/billing_address", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "billing_address" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8e18aebd-9b7f-4829-8853-363e03e72029" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4108887f-45f1-4a6b-9629-84370bbf4d4c" } ], "id": "75c5423e-74f1-42b0-beb8-a6790f0a1471", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-75c5423e-74f1-42b0-beb8-a6790f0a1471" }, { "name": "store", "item": [ { "name": "Retrieve the store associated to the order", "id": "9d7d16a1-ca31-48c0-8139-b1120f24a83b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/store", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "store" ], "variable": [ { "id": "572ff8e1-c829-4710-8b16-8b78c1ad0223", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the store associated to the order" }, "response": [ { "id": "58f34eca-2005-4300-9bf3-bff2d6878f1d", "name": "The store associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/store", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "store" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-58f34eca-2005-4300-9bf3-bff2d6878f1d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9d7d16a1-ca31-48c0-8139-b1120f24a83b" } ], "id": "08bab436-e87a-4458-807d-1079731e33b0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-08bab436-e87a-4458-807d-1079731e33b0" }, { "name": "default_shipping_method", "item": [ { "name": "Retrieve the default shipping method associated to the order", "id": "4fd1a508-77a8-47a8-9990-16390b40d388", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/default_shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "default_shipping_method" ], "variable": [ { "id": "9eded313-eced-4429-b6b8-d1dea1c0469c", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the default shipping method associated to the order" }, "response": [ { "id": "653d137f-87e0-4531-b1e4-61fa98169161", "name": "The default_shipping_method associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/default_shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "default_shipping_method" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-653d137f-87e0-4531-b1e4-61fa98169161" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4fd1a508-77a8-47a8-9990-16390b40d388" } ], "id": "306791b3-9d9b-48d9-bb43-3fa00f2d7f15", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-306791b3-9d9b-48d9-bb43-3fa00f2d7f15" }, { "name": "default_payment_method", "item": [ { "name": "Retrieve the default payment method associated to the order", "id": "3c4194c8-42b2-434a-bf32-bb9c56914c2c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/default_payment_method", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "default_payment_method" ], "variable": [ { "id": "2cd9b714-6758-4ec7-8aa3-bff35dd86788", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the default payment method associated to the order" }, "response": [ { "id": "0a747060-e1f3-48f3-b4f7-65d41ac66f73", "name": "The default_payment_method associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/default_payment_method", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "default_payment_method" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0a747060-e1f3-48f3-b4f7-65d41ac66f73" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3c4194c8-42b2-434a-bf32-bb9c56914c2c" } ], "id": "2dc05712-7774-4dfd-b819-1cff2462dd5a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2dc05712-7774-4dfd-b819-1cff2462dd5a" }, { "name": "available_payment_methods", "item": [ { "name": "Retrieve the available payment methods associated to the order", "id": "e5aad673-28f5-4cf5-a4ef-89436b179969", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_payment_methods" ], "variable": [ { "id": "569ea554-e444-4f2f-a7b3-46fc2e61ffbf", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the available payment methods associated to the order" }, "response": [ { "id": "34d141cf-15e9-4fd7-bfd0-d8528b3a6b99", "name": "The available_payment_methods associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_payment_methods" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-34d141cf-15e9-4fd7-bfd0-d8528b3a6b99" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5aad673-28f5-4cf5-a4ef-89436b179969" } ], "id": "ed6938a2-f38a-4a0e-afa7-c7add4e04502", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ed6938a2-f38a-4a0e-afa7-c7add4e04502" }, { "name": "available_customer_payment_sources", "item": [ { "name": "Retrieve the available customer payment sources associated to the order", "id": "754c53a4-6f9f-4072-aa33-cf6f387f49d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_customer_payment_sources" ], "variable": [ { "id": "5dcc6087-341d-4e0b-9e64-58243d5b2afb", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the available customer payment sources associated to the order" }, "response": [ { "id": "50f526b2-7be0-496a-abc0-dec20cf8609d", "name": "The available_customer_payment_sources associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_customer_payment_sources", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_customer_payment_sources" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-50f526b2-7be0-496a-abc0-dec20cf8609d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-754c53a4-6f9f-4072-aa33-cf6f387f49d2" } ], "id": "4a40d4ae-796c-4be4-9080-db9304f3af22", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4a40d4ae-796c-4be4-9080-db9304f3af22" }, { "name": "available_free_skus", "item": [ { "name": "Retrieve the available free skus associated to the order", "id": "36384e8e-d9b0-4f64-af97-1c823614224c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_free_skus", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_free_skus" ], "variable": [ { "id": "cb691f1a-5b6f-4d8a-80d9-027111caceed", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the available free skus associated to the order" }, "response": [ { "id": "fe92f8c6-f5fe-48ca-9ca9-891e57cc59e1", "name": "The available_free_skus associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_free_skus", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_free_skus" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fe92f8c6-f5fe-48ca-9ca9-891e57cc59e1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-36384e8e-d9b0-4f64-af97-1c823614224c" } ], "id": "f6482e51-88aa-4c14-afc6-7a7be6037c17", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f6482e51-88aa-4c14-afc6-7a7be6037c17" }, { "name": "available_free_bundles", "item": [ { "name": "Retrieve the available free bundles associated to the order", "id": "b1324589-9733-4d65-bed7-662e63e8331d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_free_bundles", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_free_bundles" ], "variable": [ { "id": "b3e65029-ff6c-4a33-af22-60683c382769", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the available free bundles associated to the order" }, "response": [ { "id": "4d728997-cdeb-4fc1-b6a3-0d943e9d1689", "name": "The available_free_bundles associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/available_free_bundles", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "available_free_bundles" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4d728997-cdeb-4fc1-b6a3-0d943e9d1689" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b1324589-9733-4d65-bed7-662e63e8331d" } ], "id": "5481e556-67f5-4b97-a6e9-cbd708d5d7f7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5481e556-67f5-4b97-a6e9-cbd708d5d7f7" }, { "name": "payment_method", "item": [ { "name": "Retrieve the payment method associated to the order", "id": "71b45a96-25bd-4e57-863f-54e8478eb0c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/payment_method", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "payment_method" ], "variable": [ { "id": "1f61e6c1-b4b1-4161-8cf8-9b001399efa5", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment method associated to the order" }, "response": [ { "id": "cc7fc565-6ec5-40c8-ad51-b8e4c9aaedd5", "name": "The payment_method associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/payment_method", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "payment_method" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cc7fc565-6ec5-40c8-ad51-b8e4c9aaedd5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-71b45a96-25bd-4e57-863f-54e8478eb0c1" } ], "id": "729010b1-2e3f-4c8f-80e4-4b4807c559c9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-729010b1-2e3f-4c8f-80e4-4b4807c559c9" }, { "name": "discount_engine_item", "item": [ { "name": "Retrieve the discount engine item associated to the order", "id": "122fa4ac-91d1-4af6-8426-eead0471f47a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/discount_engine_item", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "discount_engine_item" ], "variable": [ { "id": "7ac375f3-5bf5-421c-bf2c-2b933392a072", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the discount engine item associated to the order" }, "response": [ { "id": "791d154a-3986-486f-8d25-83e75a5174ec", "name": "The discount_engine_item associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/discount_engine_item", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "discount_engine_item" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-791d154a-3986-486f-8d25-83e75a5174ec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-122fa4ac-91d1-4af6-8426-eead0471f47a" } ], "id": "3715cd7d-8004-4829-9f66-078d6cab3860", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3715cd7d-8004-4829-9f66-078d6cab3860" }, { "name": "line_items", "item": [ { "name": "Retrieve the line items associated to the order", "id": "ed9ccf47-82e1-4271-9e53-d0d50648f168", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/line_items", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "line_items" ], "variable": [ { "id": "5b7889fb-c396-4b0c-8668-b5855bc5ef5c", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line items associated to the order" }, "response": [ { "id": "2d2aa8d5-b235-4224-9564-60dc11224898", "name": "The line_items associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/line_items", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "line_items" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2d2aa8d5-b235-4224-9564-60dc11224898" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ed9ccf47-82e1-4271-9e53-d0d50648f168" } ], "id": "ae56d6a0-1a0a-4ec8-a4a6-f9b8f67202e6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ae56d6a0-1a0a-4ec8-a4a6-f9b8f67202e6" }, { "name": "line_item_options", "item": [ { "name": "Retrieve the line item options associated to the order", "id": "49f01214-3c42-43ee-88c2-23b4ef9ff1c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "line_item_options" ], "variable": [ { "id": "7d3b552a-6eee-46da-9229-3971bcfa8861", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item options associated to the order" }, "response": [ { "id": "babb64ae-855b-4ea7-932d-7aa8172d2808", "name": "The line_item_options associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/line_item_options", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "line_item_options" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-babb64ae-855b-4ea7-932d-7aa8172d2808" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-49f01214-3c42-43ee-88c2-23b4ef9ff1c5" } ], "id": "354cb609-2192-446b-89f7-4560d64f8d80", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-354cb609-2192-446b-89f7-4560d64f8d80" }, { "name": "stock_reservations", "item": [ { "name": "Retrieve the stock reservations associated to the order", "id": "8698acfe-79b3-448c-876a-4eee5d7cf6f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "stock_reservations" ], "variable": [ { "id": "d71dc0e4-2219-4c89-9aea-981c1ee14b8b", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservations associated to the order" }, "response": [ { "id": "e1a0b23d-f777-40c2-bdc7-a58f5d6c99ca", "name": "The stock_reservations associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "stock_reservations" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e1a0b23d-f777-40c2-bdc7-a58f5d6c99ca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8698acfe-79b3-448c-876a-4eee5d7cf6f7" } ], "id": "713dd9f1-a9cb-4090-93e0-d97ee9e35b99", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-713dd9f1-a9cb-4090-93e0-d97ee9e35b99" }, { "name": "stock_line_items", "item": [ { "name": "Retrieve the stock line items associated to the order", "id": "244f5c9b-37d5-434c-a9c5-da73f510e560", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "stock_line_items" ], "variable": [ { "id": "847e0441-922a-42ad-bee7-dbd62f8efbc5", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock line items associated to the order" }, "response": [ { "id": "014a67d6-d604-4e0a-b9db-709fb4de1a15", "name": "The stock_line_items associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "stock_line_items" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-014a67d6-d604-4e0a-b9db-709fb4de1a15" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-244f5c9b-37d5-434c-a9c5-da73f510e560" } ], "id": "ff986fdd-3776-4fc5-ba41-e81385bfff46", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ff986fdd-3776-4fc5-ba41-e81385bfff46" }, { "name": "stock_transfers", "item": [ { "name": "Retrieve the stock transfers associated to the order", "id": "60d378de-71d5-4db7-b384-8d63cacd531c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "stock_transfers" ], "variable": [ { "id": "6d1449f6-33dd-483a-8123-ac7461e6d299", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock transfers associated to the order" }, "response": [ { "id": "a3e6405b-a71f-420a-9155-e34031a8f175", "name": "The stock_transfers associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "stock_transfers" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a3e6405b-a71f-420a-9155-e34031a8f175" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-60d378de-71d5-4db7-b384-8d63cacd531c" } ], "id": "fced7d0f-c213-4412-9817-8a68db147a0f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fced7d0f-c213-4412-9817-8a68db147a0f" }, { "name": "shipments", "item": [ { "name": "Retrieve the shipments associated to the order", "id": "2134085a-2f06-453c-b857-b2cf64aea886", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/shipments", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "shipments" ], "variable": [ { "id": "f13895ae-8db1-489b-b01e-982768fed30c", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipments associated to the order" }, "response": [ { "id": "9ca8c3d5-715c-48ac-9cec-b7bbc5da0e81", "name": "The shipments associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/shipments", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "shipments" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9ca8c3d5-715c-48ac-9cec-b7bbc5da0e81" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2134085a-2f06-453c-b857-b2cf64aea886" } ], "id": "6fd16a81-dee5-4e1c-bc6e-d655aa8e9516", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6fd16a81-dee5-4e1c-bc6e-d655aa8e9516" }, { "name": "payment_options", "item": [ { "name": "Retrieve the payment options associated to the order", "id": "bac2b430-5c5a-44b6-8d98-9c7d38a5bec6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/payment_options", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "payment_options" ], "variable": [ { "id": "e074b183-6fad-422f-9de6-ddc63bb722c8", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment options associated to the order" }, "response": [ { "id": "2f2a1866-d73a-4fea-8a83-be8ddab174b0", "name": "The payment_options associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/payment_options", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "payment_options" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2f2a1866-d73a-4fea-8a83-be8ddab174b0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bac2b430-5c5a-44b6-8d98-9c7d38a5bec6" } ], "id": "8321be3c-9ff0-4ccc-8ae9-09005c5b5f58", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8321be3c-9ff0-4ccc-8ae9-09005c5b5f58" }, { "name": "authorizations", "item": [ { "name": "Retrieve the authorizations associated to the order", "id": "6ad3e1d0-ef2a-41d2-8ed7-09f39c388b05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "authorizations" ], "variable": [ { "id": "35eaed79-5065-4c01-95c4-c051f29c7805", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the authorizations associated to the order" }, "response": [ { "id": "09fac9be-66b9-49b6-aca5-65dc5d8e7918", "name": "The authorizations associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "authorizations" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-09fac9be-66b9-49b6-aca5-65dc5d8e7918" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6ad3e1d0-ef2a-41d2-8ed7-09f39c388b05" } ], "id": "fecf9971-e19f-4e0b-bbe9-ee700531e313", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fecf9971-e19f-4e0b-bbe9-ee700531e313" }, { "name": "captures", "item": [ { "name": "Retrieve the captures associated to the order", "id": "17e070fc-94e3-4eb1-b607-14c220550d54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/captures", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "captures" ], "variable": [ { "id": "50ad0782-3c6d-4e4e-924e-f033c26de08b", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the captures associated to the order" }, "response": [ { "id": "f4b910cd-d798-4b03-a42d-e1cf16f9ab7b", "name": "The captures associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/captures", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "captures" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f4b910cd-d798-4b03-a42d-e1cf16f9ab7b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-17e070fc-94e3-4eb1-b607-14c220550d54" } ], "id": "31112ba7-9c47-488c-b3cf-2b589e0ffe49", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-31112ba7-9c47-488c-b3cf-2b589e0ffe49" }, { "name": "voids", "item": [ { "name": "Retrieve the voids associated to the order", "id": "3021bad7-1785-44a3-94b7-955d47b951c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/voids", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "voids" ], "variable": [ { "id": "6479508f-07e4-4ebd-8f86-1e94075007ba", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the voids associated to the order" }, "response": [ { "id": "3dcdc0d9-f065-4fa3-90b2-c461bc1fe06b", "name": "The voids associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/voids", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "voids" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3dcdc0d9-f065-4fa3-90b2-c461bc1fe06b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3021bad7-1785-44a3-94b7-955d47b951c3" } ], "id": "a0366fde-a222-4a4f-919d-22efa28f1837", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a0366fde-a222-4a4f-919d-22efa28f1837" }, { "name": "refunds", "item": [ { "name": "Retrieve the refunds associated to the order", "id": "5a5fdea0-c98b-46ca-8935-a219d7731349", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/refunds", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "refunds" ], "variable": [ { "id": "1ea9c32e-3ffc-45ec-ade2-e42be55be193", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the refunds associated to the order" }, "response": [ { "id": "1371ff8c-70b8-4272-b1da-6c5169955400", "name": "The refunds associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/refunds", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "refunds" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1371ff8c-70b8-4272-b1da-6c5169955400" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5a5fdea0-c98b-46ca-8935-a219d7731349" } ], "id": "4d885791-7c8c-46e3-9d79-350373eb73f9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4d885791-7c8c-46e3-9d79-350373eb73f9" }, { "name": "returns", "item": [ { "name": "Retrieve the returns associated to the order", "id": "de01a369-0fe4-4b07-b268-272921ade62a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/returns", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "returns" ], "variable": [ { "id": "8d33f1a0-428e-41d5-8a22-a99108ab285e", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the returns associated to the order" }, "response": [ { "id": "c678df4b-4719-4233-8dc6-3dd6c4d581c5", "name": "The returns associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/returns", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "returns" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c678df4b-4719-4233-8dc6-3dd6c4d581c5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-de01a369-0fe4-4b07-b268-272921ade62a" } ], "id": "06ebfe20-d5c9-49c6-a58c-1696c86c2cff", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-06ebfe20-d5c9-49c6-a58c-1696c86c2cff" }, { "name": "order_subscription", "item": [ { "name": "Retrieve the order subscription associated to the order", "id": "2656cabc-261b-4324-b5d7-d12b08be10e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_subscription" ], "variable": [ { "id": "2167ec01-e756-4da1-8eac-87331dfcdb1c", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscription associated to the order" }, "response": [ { "id": "6a6b9957-976b-44fb-8903-4324af3aae76", "name": "The order_subscription associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_subscription" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6a6b9957-976b-44fb-8903-4324af3aae76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2656cabc-261b-4324-b5d7-d12b08be10e7" } ], "id": "cbc0c569-147a-47d1-9762-18b72504c0d9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cbc0c569-147a-47d1-9762-18b72504c0d9" }, { "name": "order_subscriptions", "item": [ { "name": "Retrieve the order subscriptions associated to the order", "id": "971935e2-6e64-45e2-b007-1e08a371b58b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_subscriptions" ], "variable": [ { "id": "a8dfb58c-e678-470d-81fa-7984eb7af1f3", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscriptions associated to the order" }, "response": [ { "id": "a041ea3f-df4e-4bb4-8a2d-7593d66d008a", "name": "The order_subscriptions associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_subscriptions" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a041ea3f-df4e-4bb4-8a2d-7593d66d008a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-971935e2-6e64-45e2-b007-1e08a371b58b" } ], "id": "d09edcdd-1a4c-4c6c-b168-e847b33b5229", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d09edcdd-1a4c-4c6c-b168-e847b33b5229" }, { "name": "order_factories", "item": [ { "name": "Retrieve the order factories associated to the order", "id": "9652846e-1b5d-476b-a346-83b3c54b3957", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_factories", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_factories" ], "variable": [ { "id": "f63ebd60-bf2d-4440-9e65-c360044d91a0", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order factories associated to the order" }, "response": [ { "id": "af55a4cf-68f4-489d-8496-3bc55c85b76e", "name": "The order_factories associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_factories", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_factories" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-af55a4cf-68f4-489d-8496-3bc55c85b76e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9652846e-1b5d-476b-a346-83b3c54b3957" } ], "id": "32588405-f1d9-42c2-8530-20dab6888b6f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-32588405-f1d9-42c2-8530-20dab6888b6f" }, { "name": "order_copies", "item": [ { "name": "Retrieve the order copies associated to the order", "id": "142e81da-556d-4ba6-8f27-4528fb89c36c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_copies", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_copies" ], "variable": [ { "id": "9cdd53e9-47f7-4d47-9a16-bbbbcd715a1e", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order copies associated to the order" }, "response": [ { "id": "2fecdd78-2f6c-42a2-b321-a5e29a77c9ef", "name": "The order_copies associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/order_copies", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "order_copies" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2fecdd78-2f6c-42a2-b321-a5e29a77c9ef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-142e81da-556d-4ba6-8f27-4528fb89c36c" } ], "id": "d49f8487-ac12-425c-826c-719ceceee313", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d49f8487-ac12-425c-826c-719ceceee313" }, { "name": "recurring_order_copies", "item": [ { "name": "Retrieve the recurring order copies associated to the order", "id": "0edf6f0d-1358-4e93-9178-a611c0f90243", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "recurring_order_copies" ], "variable": [ { "id": "1e05f21a-683e-48b8-bb62-17bdd2917ef9", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the recurring order copies associated to the order" }, "response": [ { "id": "ebe077b6-c0e0-43f8-af72-40b21b561584", "name": "The recurring_order_copies associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "recurring_order_copies" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ebe077b6-c0e0-43f8-af72-40b21b561584" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0edf6f0d-1358-4e93-9178-a611c0f90243" } ], "id": "dd6fb6fc-0c6c-413b-83df-afa1e79d37a3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dd6fb6fc-0c6c-413b-83df-afa1e79d37a3" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the order", "id": "ea832710-e078-45c3-84f9-c50f0ab7f27e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "attachments" ], "variable": [ { "id": "d3e8a106-997e-4b4e-ae72-66103bbdd3e4", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the order" }, "response": [ { "id": "c62a3bb4-3c3e-4fef-8be1-73622d5db6e4", "name": "The attachments associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "attachments" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c62a3bb4-3c3e-4fef-8be1-73622d5db6e4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ea832710-e078-45c3-84f9-c50f0ab7f27e" } ], "id": "c71f6fd8-f00e-4a5a-8703-9a3e50844c85", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c71f6fd8-f00e-4a5a-8703-9a3e50844c85" }, { "name": "notifications", "item": [ { "name": "Retrieve the notifications associated to the order", "id": "290be78c-2ffd-458f-8524-3783bd74204f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "notifications" ], "variable": [ { "id": "6dbaead6-5691-4169-9b74-d153f241db42", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the notifications associated to the order" }, "response": [ { "id": "f3f1d172-a8b6-4107-ac72-7c462e727caa", "name": "The notifications associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "notifications" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f3f1d172-a8b6-4107-ac72-7c462e727caa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-290be78c-2ffd-458f-8524-3783bd74204f" } ], "id": "2a5c2d9c-de37-40af-86eb-ffad9259ceb7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2a5c2d9c-de37-40af-86eb-ffad9259ceb7" }, { "name": "links", "item": [ { "name": "Retrieve the links associated to the order", "id": "42f567a8-3f0d-4026-a8f2-0c7b135ce763", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/links", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "links" ], "variable": [ { "id": "3aa17d08-e734-4d87-b962-6af17e562f29", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the links associated to the order" }, "response": [ { "id": "9acecfed-4ef3-415b-b015-840934c73fbb", "name": "The links associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/links", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "links" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9acecfed-4ef3-415b-b015-840934c73fbb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-42f567a8-3f0d-4026-a8f2-0c7b135ce763" } ], "id": "5be6031a-96b2-4b86-bc2c-0279b81fd73b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5be6031a-96b2-4b86-bc2c-0279b81fd73b" }, { "name": "resource_errors", "item": [ { "name": "Retrieve the resource errors associated to the order", "id": "81eef8db-1e11-4718-97e6-1c7e549057c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/resource_errors", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "resource_errors" ], "variable": [ { "id": "41d4e950-2aae-4e97-bee5-de1d521a86d8", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the resource errors associated to the order" }, "response": [ { "id": "2c53b15a-cfc7-47d7-90ac-967989b1a51a", "name": "The resource_errors associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/resource_errors", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "resource_errors" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2c53b15a-cfc7-47d7-90ac-967989b1a51a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-81eef8db-1e11-4718-97e6-1c7e549057c1" } ], "id": "28c4d84f-2844-4737-b5d0-3ea6aa5a24f4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-28c4d84f-2844-4737-b5d0-3ea6aa5a24f4" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the order", "id": "82b74166-c1c3-4fb6-b76a-5e73551f7ff5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/events", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "events" ], "variable": [ { "id": "9022b42d-c6d6-4371-abfd-5cd0288f98e1", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the order" }, "response": [ { "id": "0c668d4e-1fbe-4930-ad8d-db33208b4205", "name": "The events associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/events", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "events" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0c668d4e-1fbe-4930-ad8d-db33208b4205" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-82b74166-c1c3-4fb6-b76a-5e73551f7ff5" } ], "id": "36c649e9-10e0-4dc1-970a-672b404dd551", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-36c649e9-10e0-4dc1-970a-672b404dd551" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the order", "id": "3c54c977-5641-4b90-90ec-25e811b639bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/tags", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "tags" ], "variable": [ { "id": "c12596fd-4e2a-4062-b143-641c0b7a7aa4", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the order" }, "response": [ { "id": "d49d0a5a-8271-4b64-acc5-8b4502a75e21", "name": "The tags associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/tags", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "tags" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d49d0a5a-8271-4b64-acc5-8b4502a75e21" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3c54c977-5641-4b90-90ec-25e811b639bd" } ], "id": "4eb53a21-c546-4246-bca6-93dcd902f950", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4eb53a21-c546-4246-bca6-93dcd902f950" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the order", "id": "9529e2ac-0471-41c4-8d50-1c52dbb9da91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "event_stores" ], "variable": [ { "id": "30875c13-709f-4477-9ec9-80b56de12eae", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the order" }, "response": [ { "id": "d421e034-f30f-4530-b873-0e2cf1ebd103", "name": "The event_stores associated to the order", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId", "event_stores" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d421e034-f30f-4530-b873-0e2cf1ebd103" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9529e2ac-0471-41c4-8d50-1c52dbb9da91" } ], "id": "bb3af687-c25f-4600-897b-cbf3742426a7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bb3af687-c25f-4600-897b-cbf3742426a7" }, { "name": "Retrieve an order", "id": "cbe89a9d-7f26-4a2d-9505-e81ea86a7034", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "id": "eb1baed4-283b-4c2d-ba07-880d3915613f", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve an order" }, "response": [ { "id": "46716340-9ca0-414d-926a-056fc3068542", "name": "The order object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"pending\",\n \"payment_status\": \"paid\",\n \"fulfillment_status\": \"in_progress\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"billing_address\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"discount_engine_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_item\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"transactions\",\n \"id\": \"\"\n }\n },\n \"authorizations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-46716340-9ca0-414d-926a-056fc3068542" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cbe89a9d-7f26-4a2d-9505-e81ea86a7034" }, { "name": "Update an order", "id": "268b05ce-6160-4f1b-a2ad-8e58c8d11106", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"guest\": \"\",\n \"customer_email\": \"\",\n \"customer_password\": \"\",\n \"language_code\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"_archive\": \"\",\n \"_unarchive\": \"\",\n \"_pending\": \"\",\n \"_place\": \"\",\n \"_cancel\": \"\",\n \"_approve\": \"\",\n \"_approve_and_capture\": \"\",\n \"_authorize\": \"\",\n \"_authorization_amount_cents\": \"\",\n \"_capture\": \"\",\n \"_refund\": \"\",\n \"_fulfill\": \"\",\n \"_update_taxes\": \"\",\n \"_nullify_payment_source\": \"\",\n \"_fix_payment_source\": \"\",\n \"_billing_address_clone_id\": \"\",\n \"_shipping_address_clone_id\": \"\",\n \"_customer_payment_source_id\": \"\",\n \"_shipping_address_same_as_billing\": \"\",\n \"_billing_address_same_as_shipping\": \"\",\n \"_commit_invoice\": \"\",\n \"_refund_invoice\": \"\",\n \"_save_payment_source_to_customer_wallet\": \"\",\n \"_save_shipping_address_to_customer_address_book\": \"\",\n \"_save_billing_address_to_customer_address_book\": \"\",\n \"_refresh\": \"\",\n \"_refresh_prices\": \"\",\n \"_validate\": \"\",\n \"_create_subscriptions\": \"\",\n \"_start_editing\": \"\",\n \"_stop_editing\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"_reset_circuit\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "id": "8f47be7f-f192-4abb-81fb-fded9db17ebf", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update an order" }, "response": [ { "id": "9a20b6e7-a57c-4624-85bf-139765381087", "name": "The updated order object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"guest\": \"\",\n \"customer_email\": \"\",\n \"customer_password\": \"\",\n \"language_code\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"_archive\": \"\",\n \"_unarchive\": \"\",\n \"_pending\": \"\",\n \"_place\": \"\",\n \"_cancel\": \"\",\n \"_approve\": \"\",\n \"_approve_and_capture\": \"\",\n \"_authorize\": \"\",\n \"_authorization_amount_cents\": \"\",\n \"_capture\": \"\",\n \"_refund\": \"\",\n \"_fulfill\": \"\",\n \"_update_taxes\": \"\",\n \"_nullify_payment_source\": \"\",\n \"_fix_payment_source\": \"\",\n \"_billing_address_clone_id\": \"\",\n \"_shipping_address_clone_id\": \"\",\n \"_customer_payment_source_id\": \"\",\n \"_shipping_address_same_as_billing\": \"\",\n \"_billing_address_same_as_shipping\": \"\",\n \"_commit_invoice\": \"\",\n \"_refund_invoice\": \"\",\n \"_save_payment_source_to_customer_wallet\": \"\",\n \"_save_shipping_address_to_customer_address_book\": \"\",\n \"_save_billing_address_to_customer_address_book\": \"\",\n \"_refresh\": \"\",\n \"_refresh_prices\": \"\",\n \"_validate\": \"\",\n \"_create_subscriptions\": \"\",\n \"_start_editing\": \"\",\n \"_stop_editing\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"_reset_circuit\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"pending\",\n \"payment_status\": \"paid\",\n \"fulfillment_status\": \"in_progress\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"billing_address\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"discount_engine_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_item\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"transactions\",\n \"id\": \"\"\n }\n },\n \"authorizations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9a20b6e7-a57c-4624-85bf-139765381087" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-268b05ce-6160-4f1b-a2ad-8e58c8d11106" }, { "name": "Delete an order", "id": "a0d733a2-6075-4331-9462-a45eaac9dda7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "id": "745b7b72-2fd1-465c-8167-8d4133089a32", "key": "orderId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete an order" }, "response": [ { "id": "4a2cb7a0-d0fe-4dee-90af-73bc86470848", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders/:orderId", "host": [ "{{baseUrl}}" ], "path": [ "orders", ":orderId" ], "variable": [ { "key": "orderId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4a2cb7a0-d0fe-4dee-90af-73bc86470848" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a0d733a2-6075-4331-9462-a45eaac9dda7" } ], "id": "ff76f90e-d099-4b91-9252-ef09b4d36343", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ff76f90e-d099-4b91-9252-ef09b4d36343" }, { "name": "List all orders", "id": "69c2ecbb-bd01-4617-a4cd-396de51b468f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "description": "List all orders" }, "response": [ { "id": "74a26600-7071-44a0-873f-1ce40802c011", "name": "A list of order objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"orders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"draft\",\n \"payment_status\": \"paid\",\n \"fulfillment_status\": \"unfulfilled\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"billing_address\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"discount_engine_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_item\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"transactions\",\n \"id\": \"\"\n }\n },\n \"authorizations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"orders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"placed\",\n \"payment_status\": \"partially_paid\",\n \"fulfillment_status\": \"fulfilled\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"billing_address\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"discount_engine_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_item\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"transactions\",\n \"id\": \"\"\n }\n },\n \"authorizations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-74a26600-7071-44a0-873f-1ce40802c011" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-69c2ecbb-bd01-4617-a4cd-396de51b468f" }, { "name": "Create an order", "id": "7d275bb9-841c-4591-9c2a-dd174f5b908e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"guest\": \"\",\n \"customer_email\": \"\",\n \"customer_password\": \"\",\n \"language_code\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] }, "description": "Create an order" }, "response": [ { "id": "7bc01482-4483-4921-9f24-16ab08b769d3", "name": "The created order object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"orders\",\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"guest\": \"\",\n \"customer_email\": \"\",\n \"customer_password\": \"\",\n \"language_code\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"data\": {\n \"type\": \"adyen_payments\",\n \"attributes\": {\n \"public_key\": \"\",\n \"payment_methods\": {},\n \"payment_request_data\": {},\n \"payment_request_details\": {},\n \"payment_response\": {},\n \"mismatched_amounts\": \"\",\n \"balance\": \"\",\n \"expires_at\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/orders", "host": [ "{{baseUrl}}" ], "path": [ "orders" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"orders\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"affiliate_code\": \"\",\n \"autorefresh\": \"\",\n \"place_async\": \"\",\n \"status\": \"pending\",\n \"payment_status\": \"paid\",\n \"fulfillment_status\": \"in_progress\",\n \"guest\": \"\",\n \"editable\": \"\",\n \"customer_email\": \"\",\n \"customer_type\": \"returning\",\n \"language_code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"requires_billing_info\": \"\",\n \"country_code\": \"\",\n \"shipping_country_code_lock\": \"\",\n \"coupon_code\": \"\",\n \"gift_card_code\": \"\",\n \"subtotal_amount_cents\": \"\",\n \"subtotal_amount_float\": \"\",\n \"formatted_subtotal_amount\": \"\",\n \"shipping_amount_cents\": \"\",\n \"shipping_amount_float\": \"\",\n \"formatted_shipping_amount\": \"\",\n \"payment_method_amount_cents\": \"\",\n \"payment_method_amount_float\": \"\",\n \"formatted_payment_method_amount\": \"\",\n \"discount_amount_cents\": \"\",\n \"discount_amount_float\": \"\",\n \"formatted_discount_amount\": \"\",\n \"adjustment_amount_cents\": \"\",\n \"adjustment_amount_float\": \"\",\n \"formatted_adjustment_amount\": \"\",\n \"gift_card_amount_cents\": \"\",\n \"gift_card_amount_float\": \"\",\n \"formatted_gift_card_amount\": \"\",\n \"total_tax_amount_cents\": \"\",\n \"total_tax_amount_float\": \"\",\n \"formatted_total_tax_amount\": \"\",\n \"subtotal_tax_amount_cents\": \"\",\n \"subtotal_tax_amount_float\": \"\",\n \"formatted_subtotal_tax_amount\": \"\",\n \"shipping_tax_amount_cents\": \"\",\n \"shipping_tax_amount_float\": \"\",\n \"formatted_shipping_tax_amount\": \"\",\n \"payment_method_tax_amount_cents\": \"\",\n \"payment_method_tax_amount_float\": \"\",\n \"formatted_payment_method_tax_amount\": \"\",\n \"adjustment_tax_amount_cents\": \"\",\n \"adjustment_tax_amount_float\": \"\",\n \"formatted_adjustment_tax_amount\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"total_taxable_amount_cents\": \"\",\n \"total_taxable_amount_float\": \"\",\n \"formatted_total_taxable_amount\": \"\",\n \"subtotal_taxable_amount_cents\": \"\",\n \"subtotal_taxable_amount_float\": \"\",\n \"formatted_subtotal_taxable_amount\": \"\",\n \"shipping_taxable_amount_cents\": \"\",\n \"shipping_taxable_amount_float\": \"\",\n \"formatted_shipping_taxable_amount\": \"\",\n \"payment_method_taxable_amount_cents\": \"\",\n \"payment_method_taxable_amount_float\": \"\",\n \"formatted_payment_method_taxable_amount\": \"\",\n \"adjustment_taxable_amount_cents\": \"\",\n \"adjustment_taxable_amount_float\": \"\",\n \"formatted_adjustment_taxable_amount\": \"\",\n \"total_amount_with_taxes_cents\": \"\",\n \"total_amount_with_taxes_float\": \"\",\n \"formatted_total_amount_with_taxes\": \"\",\n \"fees_amount_cents\": \"\",\n \"fees_amount_float\": \"\",\n \"formatted_fees_amount\": \"\",\n \"duty_amount_cents\": \"\",\n \"duty_amount_float\": \"\",\n \"formatted_duty_amount\": \"\",\n \"place_total_amount_cents\": \"\",\n \"place_total_amount_float\": \"\",\n \"formatted_place_total_amount\": \"\",\n \"skus_count\": \"\",\n \"line_item_options_count\": \"\",\n \"shipments_count\": \"\",\n \"tax_calculations_count\": \"\",\n \"validations_count\": \"\",\n \"errors_count\": \"\",\n \"payment_source_details\": {},\n \"token\": \"\",\n \"cart_url\": \"\",\n \"return_url\": \"\",\n \"terms_url\": \"\",\n \"privacy_url\": \"\",\n \"checkout_url\": \"\",\n \"placed_at\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"payment_updated_at\": \"\",\n \"fulfillment_updated_at\": \"\",\n \"refreshed_at\": \"\",\n \"archived_at\": \"\",\n \"subscription_created_at\": \"\",\n \"expires_at\": \"\",\n \"expiration_info\": {},\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"billing_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"billing_address\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"default_shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_shipping_method\",\n \"id\": \"\"\n }\n },\n \"default_payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"default_payment_method\",\n \"id\": \"\"\n }\n },\n \"available_payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_payment_methods\",\n \"id\": \"\"\n }\n },\n \"available_customer_payment_sources\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_customer_payment_sources\",\n \"id\": \"\"\n }\n },\n \"available_free_skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_skus\",\n \"id\": \"\"\n }\n },\n \"available_free_bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_free_bundles\",\n \"id\": \"\"\n }\n },\n \"payment_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_method\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"discount_engine_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_item\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"line_item_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item_options\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"shipments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"payment_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\"\n }\n },\n \"transactions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"transactions\",\n \"id\": \"\"\n }\n },\n \"authorizations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"authorizations\",\n \"id\": \"\"\n }\n },\n \"captures\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"voids\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\"\n }\n },\n \"refunds\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\"\n }\n },\n \"returns\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"order_factories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_factories\",\n \"id\": \"\"\n }\n },\n \"order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_copies\",\n \"id\": \"\"\n }\n },\n \"recurring_order_copies\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7bc01482-4483-4921-9f24-16ab08b769d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7d275bb9-841c-4591-9c2a-dd174f5b908e" } ], "id": "d78741bc-c76e-4da6-9410-3b3a6d96f4d1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d78741bc-c76e-4da6-9410-3b3a6d96f4d1" }, { "name": "organization", "item": [ { "name": "{organizationId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the organization", "id": "d5430006-3996-4d17-bec0-57b5ecf398a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/organization/:organizationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "organization", ":organizationId", "event_stores" ], "variable": [ { "id": "60e362e0-c016-45d2-8a2e-bfaeb5e2cea2", "key": "organizationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the organization" }, "response": [ { "id": "a176bbee-f772-48fe-bc2d-76ec580df3a4", "name": "The event_stores associated to the organization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization/:organizationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "organization", ":organizationId", "event_stores" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a176bbee-f772-48fe-bc2d-76ec580df3a4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d5430006-3996-4d17-bec0-57b5ecf398a5" } ], "id": "5f4fc3d8-400d-47a7-8ae2-52520cb0cbe0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5f4fc3d8-400d-47a7-8ae2-52520cb0cbe0" } ], "id": "519e3c72-7bc6-4e93-87ff-54c10947cd75", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-519e3c72-7bc6-4e93-87ff-54c10947cd75" }, { "name": "Retrieve the organization", "id": "37b58aab-0666-4ab3-bdfc-67c20245a4ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/organization", "host": [ "{{baseUrl}}" ], "path": [ "organization" ] }, "description": "Retrieve the organization" }, "response": [ { "id": "6a85890c-e985-412a-9f2f-7e81890e9e9f", "name": "The organization object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization", "host": [ "{{baseUrl}}" ], "path": [ "organization" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"organization\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"domain\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"config\": {},\n \"api_auth_redirect\": \"\",\n \"api_rules_engine\": \"\",\n \"api_rules_engine_max_conditions_size\": \"\",\n \"api_rules_engine_max_rules_size\": \"\",\n \"api_new_auth\": \"\",\n \"api_purge_single_resource\": \"\",\n \"api_max_regex_length\": \"\",\n \"addresses_avs_check\": \"\",\n \"addresses_phone_required\": \"\",\n \"orders_sales_channel_guest_only\": \"\",\n \"orders_min_rebuild_shipments_lapse\": \"\",\n \"orders_min_refresh_lapse\": \"\",\n \"orders_autorefresh_cutoff_test\": \"\",\n \"orders_autorefresh_cutoff_live\": \"\",\n \"orders_number_editable_test\": \"\",\n \"orders_number_editable_live\": \"\",\n \"orders_number_as_reference\": \"\",\n \"orders_invalid_coupon_errors\": \"\",\n \"orders_invalid_gift_card_errors\": \"\",\n \"orders_validate_shipping_stock\": \"\",\n \"bundles_max_items_count\": \"\",\n \"coupons_min_code_length\": \"\",\n \"coupons_max_code_length\": \"\",\n \"gift_cards_exact_code_matching\": \"\",\n \"gift_cards_min_code_length\": \"\",\n \"gift_cards_max_code_length\": \"\",\n \"cleanups_max_concurrent_count\": \"\",\n \"exports_max_concurrent_count\": \"\",\n \"imports_max_concurrent_count\": \"\",\n \"imports_purge_cache\": \"\",\n \"imports_skip_errors\": \"\",\n \"inventory_models_max_stock_locations_cutoff\": \"\",\n \"promotions_max_concurrent_count\": \"\",\n \"promotions_max_conditions_size\": \"\",\n \"promotions_max_rules_size\": \"\",\n \"price_lists_max_conditions_size\": \"\",\n \"price_lists_max_rules_size\": \"\",\n \"imports_trigger_webhooks\": \"\",\n \"discount_engines_enabled\": \"\",\n \"discount_engines_errors\": \"\",\n \"tags_max_name_length\": \"\",\n \"tags_max_allowed_number\": \"\",\n \"tax_calculators_errors\": \"\",\n \"external_promotions_errors\": \"\",\n \"external_prices_errors\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6a85890c-e985-412a-9f2f-7e81890e9e9f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-37b58aab-0666-4ab3-bdfc-67c20245a4ff" } ], "id": "c1b55c06-f1cf-4e65-b65e-aefe9a5ae57d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c1b55c06-f1cf-4e65-b65e-aefe9a5ae57d" }, { "name": "packages", "item": [ { "name": "{packageId}", "item": [ { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the package", "id": "d4acc273-556d-4a61-9d13-25ea929cbea1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/packages/:packageId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "stock_location" ], "variable": [ { "id": "970857aa-1e6b-48b6-b679-abc4ef327a37", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the package" }, "response": [ { "id": "bc950f54-8b7e-4d55-8c79-4f9a50977977", "name": "The stock_location associated to the package", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages/:packageId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "stock_location" ], "variable": [ { "key": "packageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bc950f54-8b7e-4d55-8c79-4f9a50977977" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d4acc273-556d-4a61-9d13-25ea929cbea1" } ], "id": "13489d20-dff4-4bcd-9e04-13118cb2d68b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-13489d20-dff4-4bcd-9e04-13118cb2d68b" }, { "name": "parcels", "item": [ { "name": "Retrieve the parcels associated to the package", "id": "8da5cd83-7cff-467b-bb61-f370aa49c9d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/packages/:packageId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "parcels" ], "variable": [ { "id": "17f259c4-cdec-48eb-ad74-554a69e559ce", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the parcels associated to the package" }, "response": [ { "id": "90623125-9c55-450c-9d5b-44bfeb21b28b", "name": "The parcels associated to the package", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages/:packageId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "parcels" ], "variable": [ { "key": "packageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-90623125-9c55-450c-9d5b-44bfeb21b28b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8da5cd83-7cff-467b-bb61-f370aa49c9d2" } ], "id": "6766efa4-b2a2-4827-944e-b2a2aac98f6b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6766efa4-b2a2-4827-944e-b2a2aac98f6b" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the package", "id": "1ee3cf77-bc24-4244-b1d1-3581fbb8c5fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/packages/:packageId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "attachments" ], "variable": [ { "id": "de856958-c4ae-4f66-bb40-03dae61a4547", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the package" }, "response": [ { "id": "c84a4b08-1af8-407b-92f4-312cd79347ed", "name": "The attachments associated to the package", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages/:packageId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "attachments" ], "variable": [ { "key": "packageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c84a4b08-1af8-407b-92f4-312cd79347ed" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ee3cf77-bc24-4244-b1d1-3581fbb8c5fc" } ], "id": "23047ed6-ac6d-4da2-9e7a-849eb3d64b72", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-23047ed6-ac6d-4da2-9e7a-849eb3d64b72" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the package", "id": "b67f6329-ccd4-4c14-8fa1-2304d2f55492", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/packages/:packageId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "event_stores" ], "variable": [ { "id": "f2a241e0-fc39-4671-8d6a-e6bf7829b704", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the package" }, "response": [ { "id": "cf8f1b03-30be-4b78-8c6e-20e9e2388386", "name": "The event_stores associated to the package", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages/:packageId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId", "event_stores" ], "variable": [ { "key": "packageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cf8f1b03-30be-4b78-8c6e-20e9e2388386" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b67f6329-ccd4-4c14-8fa1-2304d2f55492" } ], "id": "d9f298b7-272c-4cf3-a527-5b3d1aba28d9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d9f298b7-272c-4cf3-a527-5b3d1aba28d9" }, { "name": "Retrieve a package", "id": "855891af-09b1-493f-a717-7914449c1d80", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/packages/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId" ], "variable": [ { "id": "b8c236d0-d699-49d9-9c1c-3d274b41472c", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a package" }, "response": [ { "id": "346e85df-54ee-425a-bcbe-938d5236d6a8", "name": "The package object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId" ], "variable": [ { "key": "packageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"packages\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-346e85df-54ee-425a-bcbe-938d5236d6a8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-855891af-09b1-493f-a717-7914449c1d80" }, { "name": "Update a package", "id": "61728d96-3b1b-4a3d-a030-678309a7ac6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/packages/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId" ], "variable": [ { "id": "9759afe7-97c0-4663-b78b-24350c57d02f", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a package" }, "response": [ { "id": "00dd8b96-30af-4ad5-849e-f1cb4035199a", "name": "The updated package object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/packages/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId" ], "variable": [ { "key": "packageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"packages\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-00dd8b96-30af-4ad5-849e-f1cb4035199a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-61728d96-3b1b-4a3d-a030-678309a7ac6e" }, { "name": "Delete a package", "id": "e714c897-cbd0-42c0-bdf9-8bf4943dfea5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/packages/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId" ], "variable": [ { "id": "69180129-6b6e-4c7f-b665-b4c3be43c324", "key": "packageId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a package" }, "response": [ { "id": "a33e46a0-bf85-42d7-b45a-feea7e90c3e5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages/:packageId", "host": [ "{{baseUrl}}" ], "path": [ "packages", ":packageId" ], "variable": [ { "key": "packageId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a33e46a0-bf85-42d7-b45a-feea7e90c3e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e714c897-cbd0-42c0-bdf9-8bf4943dfea5" } ], "id": "321e4872-9f21-4dd5-9bda-987e60b3ed74", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-321e4872-9f21-4dd5-9bda-987e60b3ed74" }, { "name": "List all packages", "id": "c9ab41c2-6d85-43fb-a094-a7630c1285e2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/packages", "host": [ "{{baseUrl}}" ], "path": [ "packages" ] }, "description": "List all packages" }, "response": [ { "id": "36b22f23-12eb-4b5f-a131-69e3924450aa", "name": "A list of package objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/packages", "host": [ "{{baseUrl}}" ], "path": [ "packages" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"packages\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"packages\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-36b22f23-12eb-4b5f-a131-69e3924450aa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c9ab41c2-6d85-43fb-a094-a7630c1285e2" }, { "name": "Create a package", "id": "bca79f21-add4-43b8-8c19-85ae7a413895", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"packages\",\n \"attributes\": {\n \"name\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/packages", "host": [ "{{baseUrl}}" ], "path": [ "packages" ] }, "description": "Create a package" }, "response": [ { "id": "e29b0f84-0608-45c0-b57d-a8a9091a1e94", "name": "The created package object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"packages\",\n \"attributes\": {\n \"name\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/packages", "host": [ "{{baseUrl}}" ], "path": [ "packages" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"packages\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"length\": \"\",\n \"width\": \"\",\n \"height\": \"\",\n \"unit_of_length\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e29b0f84-0608-45c0-b57d-a8a9091a1e94" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bca79f21-add4-43b8-8c19-85ae7a413895" } ], "id": "f0292d57-bd9f-4688-9483-726f6290711b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f0292d57-bd9f-4688-9483-726f6290711b" }, { "name": "parcel_line_items", "item": [ { "name": "{parcelLineItemId}", "item": [ { "name": "parcel", "item": [ { "name": "Retrieve the parcel associated to the parcel line item", "id": "356e5cfe-ebdf-436f-b7c7-0f44be6a2cbf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId/parcel", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId", "parcel" ], "variable": [ { "id": "1d8f3b61-ede9-423c-b724-cdecb7160452", "key": "parcelLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the parcel associated to the parcel line item" }, "response": [ { "id": "4002d9ca-cf62-40ec-b9ad-cd278630684e", "name": "The parcel associated to the parcel line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId/parcel", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId", "parcel" ], "variable": [ { "key": "parcelLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4002d9ca-cf62-40ec-b9ad-cd278630684e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-356e5cfe-ebdf-436f-b7c7-0f44be6a2cbf" } ], "id": "f8032d78-9132-494b-842a-776d5860bdd5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f8032d78-9132-494b-842a-776d5860bdd5" }, { "name": "stock_line_item", "item": [ { "name": "Retrieve the stock line item associated to the parcel line item", "id": "16de9d8e-1293-4cd9-90b2-937ffc421e65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId/stock_line_item", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId", "stock_line_item" ], "variable": [ { "id": "9c8c2ad2-4f6e-4c03-8967-864c360c3612", "key": "parcelLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock line item associated to the parcel line item" }, "response": [ { "id": "7acbeaca-5b5a-4a37-9a04-e49feed09044", "name": "The stock_line_item associated to the parcel line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId/stock_line_item", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId", "stock_line_item" ], "variable": [ { "key": "parcelLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7acbeaca-5b5a-4a37-9a04-e49feed09044" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-16de9d8e-1293-4cd9-90b2-937ffc421e65" } ], "id": "459d301c-bcd1-4f5c-a2d6-c6c3e04db788", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-459d301c-bcd1-4f5c-a2d6-c6c3e04db788" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the parcel line item", "id": "2f73c1c2-24d8-4de7-b6f3-23fa9079476a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId", "event_stores" ], "variable": [ { "id": "7a859933-5b98-4ae8-8fd5-7988dcbe3fab", "key": "parcelLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the parcel line item" }, "response": [ { "id": "126fac9b-9016-4694-ae93-a20e4723ba98", "name": "The event_stores associated to the parcel line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId", "event_stores" ], "variable": [ { "key": "parcelLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-126fac9b-9016-4694-ae93-a20e4723ba98" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2f73c1c2-24d8-4de7-b6f3-23fa9079476a" } ], "id": "b1afcc34-a647-423a-a370-c58c435393b5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b1afcc34-a647-423a-a370-c58c435393b5" }, { "name": "Retrieve a parcel line item", "id": "7c19c4d6-2d0c-4462-a89b-5324c769940f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId" ], "variable": [ { "id": "7a7886c2-eb35-4500-89ea-7298f74c6745", "key": "parcelLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a parcel line item" }, "response": [ { "id": "fb19df25-e6cb-4dd9-999b-44f748776df1", "name": "The parcel line item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId" ], "variable": [ { "key": "parcelLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"parcel_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fb19df25-e6cb-4dd9-999b-44f748776df1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7c19c4d6-2d0c-4462-a89b-5324c769940f" }, { "name": "Update a parcel line item", "id": "fbe8b4ea-eb18-42f4-8174-734e6c9adf34", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId" ], "variable": [ { "id": "769cab40-bdab-4591-b5b3-f23fabaf8b6b", "key": "parcelLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a parcel line item" }, "response": [ { "id": "6266252f-101e-46b0-8f54-776f7a81a445", "name": "The updated parcel line item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId" ], "variable": [ { "key": "parcelLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"parcel_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6266252f-101e-46b0-8f54-776f7a81a445" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fbe8b4ea-eb18-42f4-8174-734e6c9adf34" }, { "name": "Delete a parcel line item", "id": "02753a56-466f-47da-9585-b57e3a95534a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId" ], "variable": [ { "id": "16a8d055-170f-46d5-9295-1a88a1d74cbb", "key": "parcelLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a parcel line item" }, "response": [ { "id": "bcf4b7ee-e968-4434-a400-06c341d507be", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcel_line_items/:parcelLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items", ":parcelLineItemId" ], "variable": [ { "key": "parcelLineItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bcf4b7ee-e968-4434-a400-06c341d507be" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-02753a56-466f-47da-9585-b57e3a95534a" } ], "id": "59502374-e95c-4340-b935-fc90cb3c1266", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-59502374-e95c-4340-b935-fc90cb3c1266" }, { "name": "List all parcel line items", "id": "5c7eba97-d3bf-4bce-a63e-ad5fa3244bc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/parcel_line_items", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items" ] }, "description": "List all parcel line items" }, "response": [ { "id": "dae3c106-8672-447f-85b5-ce7c695390f1", "name": "A list of parcel line item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcel_line_items", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"parcel_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"parcel_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dae3c106-8672-447f-85b5-ce7c695390f1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5c7eba97-d3bf-4bce-a63e-ad5fa3244bc1" }, { "name": "Create a parcel line item", "id": "e2bbdf0e-65fe-4e57-a1c1-ac4326a05484", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcel_line_items", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items" ] }, "description": "Create a parcel line item" }, "response": [ { "id": "ee81f052-664e-44d6-bd89-1323ed68525d", "name": "The created parcel line item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcel_line_items", "host": [ "{{baseUrl}}" ], "path": [ "parcel_line_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"parcel_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"parcel\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ee81f052-664e-44d6-bd89-1323ed68525d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e2bbdf0e-65fe-4e57-a1c1-ac4326a05484" } ], "id": "d16a216d-45f2-4c73-8ced-98ae0cfed51f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d16a216d-45f2-4c73-8ced-98ae0cfed51f" }, { "name": "parcels", "item": [ { "name": "{parcelId}", "item": [ { "name": "shipment", "item": [ { "name": "Retrieve the shipment associated to the parcel", "id": "19d12b6f-e297-462e-8660-9a6a46793ea2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "shipment" ], "variable": [ { "id": "c8a6c639-0d89-4b6a-9ece-cf5f3f508cb2", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipment associated to the parcel" }, "response": [ { "id": "7683a49a-eca6-4d87-a8c2-8b5f81edeb24", "name": "The shipment associated to the parcel", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "shipment" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7683a49a-eca6-4d87-a8c2-8b5f81edeb24" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19d12b6f-e297-462e-8660-9a6a46793ea2" } ], "id": "650c6930-67f4-4774-b6fd-395c55925781", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-650c6930-67f4-4774-b6fd-395c55925781" }, { "name": "package", "item": [ { "name": "Retrieve the package associated to the parcel", "id": "88aa5315-33ed-4d89-8c7f-ac74d8ea0eff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/package", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "package" ], "variable": [ { "id": "79e66c94-3fa1-4db9-bd5c-9da67cc0702d", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the package associated to the parcel" }, "response": [ { "id": "fd029e56-022d-4ce6-a579-cae0db9ac6a9", "name": "The package associated to the parcel", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/package", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "package" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fd029e56-022d-4ce6-a579-cae0db9ac6a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-88aa5315-33ed-4d89-8c7f-ac74d8ea0eff" } ], "id": "bd84969e-f656-46c9-b04f-6a341c75ed51", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bd84969e-f656-46c9-b04f-6a341c75ed51" }, { "name": "parcel_line_items", "item": [ { "name": "Retrieve the parcel line items associated to the parcel", "id": "9a2dcff5-3a4d-4f25-8e28-f6c17ea8b45d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/parcel_line_items", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "parcel_line_items" ], "variable": [ { "id": "0f7bb2f2-ca95-48c2-a518-02354acfcffc", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the parcel line items associated to the parcel" }, "response": [ { "id": "7fee5620-1ad6-4f93-a1bb-95fe5b610885", "name": "The parcel_line_items associated to the parcel", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/parcel_line_items", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "parcel_line_items" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7fee5620-1ad6-4f93-a1bb-95fe5b610885" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9a2dcff5-3a4d-4f25-8e28-f6c17ea8b45d" } ], "id": "51653131-e722-4286-a768-6f8a236f6a0d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-51653131-e722-4286-a768-6f8a236f6a0d" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the parcel", "id": "88592280-d08b-40c9-b5c5-ef56a495bfc8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "attachments" ], "variable": [ { "id": "2571f988-1000-46c0-8f6b-d5dc8b4119c0", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the parcel" }, "response": [ { "id": "33421e04-eab6-433b-b3f2-b1b7b50d655a", "name": "The attachments associated to the parcel", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "attachments" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-33421e04-eab6-433b-b3f2-b1b7b50d655a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-88592280-d08b-40c9-b5c5-ef56a495bfc8" } ], "id": "4d2222da-640f-4059-8a93-56f7c72619a7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4d2222da-640f-4059-8a93-56f7c72619a7" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the parcel", "id": "68cd795e-493d-407e-b7fe-1fbd7de74cc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/events", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "events" ], "variable": [ { "id": "db19de88-de8d-48b1-bc29-4d072b189360", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the parcel" }, "response": [ { "id": "c7c9adeb-bf26-4c8c-ba4d-706c245e82f6", "name": "The events associated to the parcel", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/events", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "events" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c7c9adeb-bf26-4c8c-ba4d-706c245e82f6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-68cd795e-493d-407e-b7fe-1fbd7de74cc4" } ], "id": "0e1bbb7b-9ffb-41ff-a5f3-9429104ef6c4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0e1bbb7b-9ffb-41ff-a5f3-9429104ef6c4" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the parcel", "id": "892fcb58-72ce-4680-aa85-439b8a5d94fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "event_stores" ], "variable": [ { "id": "af6d0d12-a214-4894-a095-6cd5a4b59d90", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the parcel" }, "response": [ { "id": "2b45cdde-ed5f-436c-885f-3aeb3cd85b53", "name": "The event_stores associated to the parcel", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId", "event_stores" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2b45cdde-ed5f-436c-885f-3aeb3cd85b53" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-892fcb58-72ce-4680-aa85-439b8a5d94fb" } ], "id": "5fbacee8-f20f-437a-a5e8-f2bc145b2205", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5fbacee8-f20f-437a-a5e8-f2bc145b2205" }, { "name": "Retrieve a parcel", "id": "ef3d297a-fe93-40aa-9e9d-eb3b6ccd157e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId" ], "variable": [ { "id": "e7316e6c-c49f-4d4f-b88f-233e77144e4c", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a parcel" }, "response": [ { "id": "d6bdf31b-e76d-4bff-bce4-0bb1e766acb8", "name": "The parcel object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"parcels\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"package\",\n \"id\": \"\"\n }\n },\n \"parcel_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d6bdf31b-e76d-4bff-bce4-0bb1e766acb8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ef3d297a-fe93-40aa-9e9d-eb3b6ccd157e" }, { "name": "Update a parcel", "id": "2e96d568-3aeb-4f55-859a-2ea27abfecc7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\",\n \"attributes\": {\n \"weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcels/:parcelId", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId" ], "variable": [ { "id": "9e8f7b1e-439c-46ce-97b8-476b21608538", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a parcel" }, "response": [ { "id": "9bc9da6e-ec2a-4245-98b7-5ffd443e5ff4", "name": "The updated parcel object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\",\n \"attributes\": {\n \"weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcels/:parcelId", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId" ], "variable": [ { "key": "parcelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"parcels\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"package\",\n \"id\": \"\"\n }\n },\n \"parcel_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9bc9da6e-ec2a-4245-98b7-5ffd443e5ff4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e96d568-3aeb-4f55-859a-2ea27abfecc7" }, { "name": "Delete a parcel", "id": "7772c9dd-fc88-4b0d-8c4a-c7920a58df0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/parcels/:parcelId", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId" ], "variable": [ { "id": "2a04d10c-9e33-4ce1-9c59-466be5425d80", "key": "parcelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a parcel" }, "response": [ { "id": "d358838e-8dee-4fbc-be64-816fe6080cd8", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels/:parcelId", "host": [ "{{baseUrl}}" ], "path": [ "parcels", ":parcelId" ], "variable": [ { "key": "parcelId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d358838e-8dee-4fbc-be64-816fe6080cd8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7772c9dd-fc88-4b0d-8c4a-c7920a58df0a" } ], "id": "b35009a7-9f18-4583-8428-2cf4faa25ced", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b35009a7-9f18-4583-8428-2cf4faa25ced" }, { "name": "List all parcels", "id": "82e0a4f3-44de-44cf-82db-36110ba90f8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/parcels", "host": [ "{{baseUrl}}" ], "path": [ "parcels" ] }, "description": "List all parcels" }, "response": [ { "id": "8e0d487f-1bb4-4175-a46c-8302dd1dcc88", "name": "A list of parcel objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/parcels", "host": [ "{{baseUrl}}" ], "path": [ "parcels" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"parcels\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"package\",\n \"id\": \"\"\n }\n },\n \"parcel_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"parcels\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"package\",\n \"id\": \"\"\n }\n },\n \"parcel_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8e0d487f-1bb4-4175-a46c-8302dd1dcc88" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-82e0a4f3-44de-44cf-82db-36110ba90f8a" }, { "name": "Create a parcel", "id": "6a73c938-d58c-41b6-bf0e-10ba13a17e59", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcels\",\n \"attributes\": {\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcels", "host": [ "{{baseUrl}}" ], "path": [ "parcels" ] }, "description": "Create a parcel" }, "response": [ { "id": "d6d8ab59-ed03-42d2-8fd1-364e8618e78b", "name": "The created parcel object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"parcels\",\n \"attributes\": {\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"data\": {\n \"type\": \"packages\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parcels", "host": [ "{{baseUrl}}" ], "path": [ "parcels" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"parcels\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"eel_pfc\": \"\",\n \"contents_type\": \"\",\n \"contents_explanation\": \"\",\n \"customs_certify\": \"\",\n \"customs_signer\": \"\",\n \"non_delivery_option\": \"\",\n \"restriction_type\": \"\",\n \"restriction_comments\": \"\",\n \"customs_info_required\": \"\",\n \"shipping_label_url\": \"\",\n \"shipping_label_file_type\": \"\",\n \"shipping_label_size\": \"\",\n \"shipping_label_resolution\": \"\",\n \"tracking_number\": \"\",\n \"tracking_status\": \"\",\n \"tracking_status_detail\": \"\",\n \"tracking_status_updated_at\": \"\",\n \"carrier_weight_oz\": \"\",\n \"signed_by\": \"\",\n \"incoterm\": \"\",\n \"delivery_confirmation\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"package\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"package\",\n \"id\": \"\"\n }\n },\n \"parcel_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcel_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d6d8ab59-ed03-42d2-8fd1-364e8618e78b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6a73c938-d58c-41b6-bf0e-10ba13a17e59" } ], "id": "f6144e9c-b3bb-4bad-a75f-6becb5153ef2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f6144e9c-b3bb-4bad-a75f-6becb5153ef2" }, { "name": "payment_gateways", "item": [ { "name": "{paymentGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the payment gateway", "id": "1aeea33c-36bb-4492-916d-178b183215c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_gateways/:paymentGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways", ":paymentGatewayId", "payment_methods" ], "variable": [ { "id": "7b85fc28-e7c4-4388-af06-5312d3c3865b", "key": "paymentGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the payment gateway" }, "response": [ { "id": "b1555f44-b3d1-4eb2-bd1d-4708ac07343d", "name": "The payment_methods associated to the payment gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_gateways/:paymentGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways", ":paymentGatewayId", "payment_methods" ], "variable": [ { "key": "paymentGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b1555f44-b3d1-4eb2-bd1d-4708ac07343d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1aeea33c-36bb-4492-916d-178b183215c2" } ], "id": "3b826069-982a-45fc-84a2-4327fb275896", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3b826069-982a-45fc-84a2-4327fb275896" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the payment gateway", "id": "f85f155e-12cf-4c3e-b5fd-db3b2223ed68", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_gateways/:paymentGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways", ":paymentGatewayId", "event_stores" ], "variable": [ { "id": "58331506-6edc-4aef-809f-39216ae30a52", "key": "paymentGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the payment gateway" }, "response": [ { "id": "f8da37cc-62c7-4f1b-bf3c-43968ff19488", "name": "The event_stores associated to the payment gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_gateways/:paymentGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways", ":paymentGatewayId", "event_stores" ], "variable": [ { "key": "paymentGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f8da37cc-62c7-4f1b-bf3c-43968ff19488" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f85f155e-12cf-4c3e-b5fd-db3b2223ed68" } ], "id": "2e50b578-2cf3-41ae-88fb-f1bd4a390776", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2e50b578-2cf3-41ae-88fb-f1bd4a390776" }, { "name": "Retrieve a payment gateway", "id": "c76df591-5433-4e77-8e42-c74a34b94e92", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/payment_gateways/:paymentGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways", ":paymentGatewayId" ], "variable": [ { "id": "25f4e8d5-ed07-479f-a46a-006468774f89", "key": "paymentGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a payment gateway" }, "response": [ { "id": "146f0964-e15f-4a7d-8d33-39a80c510a38", "name": "The payment gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_gateways/:paymentGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways", ":paymentGatewayId" ], "variable": [ { "key": "paymentGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-146f0964-e15f-4a7d-8d33-39a80c510a38" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c76df591-5433-4e77-8e42-c74a34b94e92" } ], "id": "ee2a324f-1c1e-4ec4-a00b-d0fe5ed952ad", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ee2a324f-1c1e-4ec4-a00b-d0fe5ed952ad" }, { "name": "List all payment gateways", "id": "3ce08e32-c9cb-4e65-a882-d05d2fca77e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/payment_gateways", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways" ] }, "description": "List all payment gateways" }, "response": [ { "id": "ad4311a7-c168-4925-b68d-576cb5435382", "name": "A list of payment gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_gateways", "host": [ "{{baseUrl}}" ], "path": [ "payment_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"payment_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"payment_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ad4311a7-c168-4925-b68d-576cb5435382" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3ce08e32-c9cb-4e65-a882-d05d2fca77e9" } ], "id": "759ff047-82b9-40a7-9dc9-18fe7bf9a60a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-759ff047-82b9-40a7-9dc9-18fe7bf9a60a" }, { "name": "payment_methods", "item": [ { "name": "{paymentMethodId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the payment method", "id": "6f0379f6-ea19-492d-b630-e707b20cba26", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/market", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "market" ], "variable": [ { "id": "43443ed3-b344-46db-b5c7-236fc5398a17", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the payment method" }, "response": [ { "id": "4fbdb154-055b-447b-9280-3f7e77bc4236", "name": "The market associated to the payment method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/market", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "market" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4fbdb154-055b-447b-9280-3f7e77bc4236" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f0379f6-ea19-492d-b630-e707b20cba26" } ], "id": "0cf93514-4d56-4f18-b90b-47d00807cfc8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0cf93514-4d56-4f18-b90b-47d00807cfc8" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the payment method", "id": "9e45e713-8b6a-4e16-b9a0-8d95d96d1ec2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "payment_gateway" ], "variable": [ { "id": "b407ce6b-8995-46f3-9a56-49cf40378de5", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the payment method" }, "response": [ { "id": "67e3d9c2-5f66-4e59-a59c-218b7350237a", "name": "The payment_gateway associated to the payment method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "payment_gateway" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-67e3d9c2-5f66-4e59-a59c-218b7350237a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9e45e713-8b6a-4e16-b9a0-8d95d96d1ec2" } ], "id": "1fe1f12e-944d-4f61-8475-44d2adff8685", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1fe1f12e-944d-4f61-8475-44d2adff8685" }, { "name": "store", "item": [ { "name": "Retrieve the store associated to the payment method", "id": "92df83a4-0122-453a-8cb7-6ead75e1ff35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/store", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "store" ], "variable": [ { "id": "c1e774f4-b7a7-461d-afb3-022d6b5955fc", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the store associated to the payment method" }, "response": [ { "id": "cb30faba-9832-4cc4-9e0e-362e20323dbb", "name": "The store associated to the payment method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/store", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "store" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cb30faba-9832-4cc4-9e0e-362e20323dbb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-92df83a4-0122-453a-8cb7-6ead75e1ff35" } ], "id": "d083cfd9-6101-43e3-8c60-a9971c4e6db1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d083cfd9-6101-43e3-8c60-a9971c4e6db1" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the payment method", "id": "d82286ee-a937-48f3-840a-f8074f7b1dc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "attachments" ], "variable": [ { "id": "2494da31-3238-4216-ac6a-92d736dc39af", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the payment method" }, "response": [ { "id": "5a1ee6ad-cb02-40e2-891b-c54dad830051", "name": "The attachments associated to the payment method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "attachments" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5a1ee6ad-cb02-40e2-891b-c54dad830051" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d82286ee-a937-48f3-840a-f8074f7b1dc1" } ], "id": "242cd82d-e1cc-4c95-945d-b06240ea9aee", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-242cd82d-e1cc-4c95-945d-b06240ea9aee" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the payment method", "id": "089292c5-4298-4182-97e3-b456d9f19491", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "event_stores" ], "variable": [ { "id": "ed3a2c5e-176d-47ce-8f1c-cd7ca6a56f6f", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the payment method" }, "response": [ { "id": "92e97071-4d1c-467f-9378-b47afe994c2b", "name": "The event_stores associated to the payment method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId", "event_stores" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-92e97071-4d1c-467f-9378-b47afe994c2b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-089292c5-4298-4182-97e3-b456d9f19491" } ], "id": "9b0a3be4-2b9a-46cb-a1d5-b2772e1f6533", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9b0a3be4-2b9a-46cb-a1d5-b2772e1f6533" }, { "name": "Retrieve a payment method", "id": "e70c0003-b136-405c-90dd-90024760dd10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId" ], "variable": [ { "id": "4b69236c-913d-4a1c-992b-961c80e1857b", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a payment method" }, "response": [ { "id": "d09621a6-62dd-470b-9361-cd7a99b54b12", "name": "The payment method object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"auto_capture_max_amount_float\": \"\",\n \"formatted_auto_capture_max_amount\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d09621a6-62dd-470b-9361-cd7a99b54b12" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e70c0003-b136-405c-90dd-90024760dd10" }, { "name": "Update a payment method", "id": "8d732af3-dbe8-4fe5-aabd-0aeae6208c4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"external_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId" ], "variable": [ { "id": "07086f14-d3c0-473e-83f5-e41cee77d493", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a payment method" }, "response": [ { "id": "8377bf6f-b2ca-4d3c-b763-6fc9b4b0a58d", "name": "The updated payment method object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"external_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"auto_capture_max_amount_float\": \"\",\n \"formatted_auto_capture_max_amount\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8377bf6f-b2ca-4d3c-b763-6fc9b4b0a58d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8d732af3-dbe8-4fe5-aabd-0aeae6208c4a" }, { "name": "Delete a payment method", "id": "ba853ee1-0d8c-4e0a-b8b7-7271471e32b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId" ], "variable": [ { "id": "9dd73b9f-1f80-43f8-bc96-f8d89e940485", "key": "paymentMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a payment method" }, "response": [ { "id": "c88bd2b8-e0f8-45ad-aebe-39a05c8f3110", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods/:paymentMethodId", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods", ":paymentMethodId" ], "variable": [ { "key": "paymentMethodId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c88bd2b8-e0f8-45ad-aebe-39a05c8f3110" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba853ee1-0d8c-4e0a-b8b7-7271471e32b0" } ], "id": "d7940fa3-52ce-4c93-867e-12e0e39b00f4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d7940fa3-52ce-4c93-867e-12e0e39b00f4" }, { "name": "List all payment methods", "id": "dd4f624a-d1d5-4ee8-8fd7-44ef2d2422c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] }, "description": "List all payment methods" }, "response": [ { "id": "edae4faf-b56b-4b90-9cb4-1cb460cd3daa", "name": "A list of payment method objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"payment_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"auto_capture_max_amount_float\": \"\",\n \"formatted_auto_capture_max_amount\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"payment_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"external_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"auto_capture_max_amount_float\": \"\",\n \"formatted_auto_capture_max_amount\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-edae4faf-b56b-4b90-9cb4-1cb460cd3daa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dd4f624a-d1d5-4ee8-8fd7-44ef2d2422c1" }, { "name": "Create a payment method", "id": "ba5969e6-8efc-4dc6-aff8-3ad6bef900f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_methods\",\n \"attributes\": {\n \"payment_source_type\": \"paypal_payments\",\n \"price_amount_cents\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] }, "description": "Create a payment method" }, "response": [ { "id": "53e98d4d-2777-41eb-920d-38a5768cb8a6", "name": "The created payment method object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_methods\",\n \"attributes\": {\n \"payment_source_type\": \"paypal_payments\",\n \"price_amount_cents\": \"\",\n \"name\": \"\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_gateway\": {\n \"data\": {\n \"type\": \"payment_gateways\",\n \"id\": \"\"\n }\n },\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "payment_methods" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"currency_code\": \"\",\n \"moto\": \"\",\n \"require_capture\": \"\",\n \"auto_place\": \"\",\n \"auto_capture\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"auto_capture_max_amount_cents\": \"\",\n \"auto_capture_max_amount_float\": \"\",\n \"formatted_auto_capture_max_amount\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"store\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"store\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-53e98d4d-2777-41eb-920d-38a5768cb8a6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba5969e6-8efc-4dc6-aff8-3ad6bef900f6" } ], "id": "c91d7b43-f7d3-480e-a77d-dd87c09b567a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c91d7b43-f7d3-480e-a77d-dd87c09b567a" }, { "name": "payment_options", "item": [ { "name": "{paymentOptionId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the payment option", "id": "6c044e0a-447a-4254-8d3d-bb87383cb082", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId/order", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId", "order" ], "variable": [ { "id": "972fc335-4d87-4e09-a078-69b9ac6f24a4", "key": "paymentOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the payment option" }, "response": [ { "id": "942c1618-8f2e-4849-a351-babad439b4f5", "name": "The order associated to the payment option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId/order", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId", "order" ], "variable": [ { "key": "paymentOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-942c1618-8f2e-4849-a351-babad439b4f5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6c044e0a-447a-4254-8d3d-bb87383cb082" } ], "id": "219f29af-3007-4384-b825-3add970cbd1f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-219f29af-3007-4384-b825-3add970cbd1f" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the payment option", "id": "b707cd92-58d2-4ee8-beeb-95bcfa74f250", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId", "attachments" ], "variable": [ { "id": "abe235d7-7b84-458a-9dc0-ea949b2f7be3", "key": "paymentOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the payment option" }, "response": [ { "id": "9300e9e4-abc4-4dbc-bd6a-c0957b19c510", "name": "The attachments associated to the payment option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId", "attachments" ], "variable": [ { "key": "paymentOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9300e9e4-abc4-4dbc-bd6a-c0957b19c510" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b707cd92-58d2-4ee8-beeb-95bcfa74f250" } ], "id": "a4339098-614c-410a-a77c-f2240c679d28", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a4339098-614c-410a-a77c-f2240c679d28" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the payment option", "id": "2b4490a9-e004-49ed-994f-4c4bc7ee4e43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId", "event_stores" ], "variable": [ { "id": "942b67b2-a3d6-421d-bebd-40274ccf0061", "key": "paymentOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the payment option" }, "response": [ { "id": "beaec5de-7921-4b6e-9ee7-a2a76792cd76", "name": "The event_stores associated to the payment option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId", "event_stores" ], "variable": [ { "key": "paymentOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-beaec5de-7921-4b6e-9ee7-a2a76792cd76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2b4490a9-e004-49ed-994f-4c4bc7ee4e43" } ], "id": "11e356d8-bb1d-444a-b0fc-a8a018de950e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-11e356d8-bb1d-444a-b0fc-a8a018de950e" }, { "name": "Retrieve a payment option", "id": "491f0b10-36e5-4f2e-bf63-a69c45dd553d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId" ], "variable": [ { "id": "d14e7024-d65b-461a-9d38-441a3bbe99af", "key": "paymentOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a payment option" }, "response": [ { "id": "82001405-a623-4872-a0a0-f6e8c12504d3", "name": "The payment option object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId" ], "variable": [ { "key": "paymentOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"data\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-82001405-a623-4872-a0a0-f6e8c12504d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-491f0b10-36e5-4f2e-bf63-a69c45dd553d" }, { "name": "Update a payment option", "id": "96ff0eb0-29db-4f4d-9011-049ce04271b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"data\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId" ], "variable": [ { "id": "31126463-ffbe-4981-9a26-8f6b68e3b50b", "key": "paymentOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a payment option" }, "response": [ { "id": "410f2428-10e5-4498-925b-3a1e16e76b1b", "name": "The updated payment option object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_options\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"data\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId" ], "variable": [ { "key": "paymentOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"data\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-410f2428-10e5-4498-925b-3a1e16e76b1b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-96ff0eb0-29db-4f4d-9011-049ce04271b8" }, { "name": "Delete a payment option", "id": "bb7f678d-e42f-442e-a8d5-0237d6c827ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId" ], "variable": [ { "id": "09bb1d93-73d7-418c-8c92-fb5d7a3f2439", "key": "paymentOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a payment option" }, "response": [ { "id": "936720e1-ff3b-4f3f-967d-d48104afb7d2", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_options/:paymentOptionId", "host": [ "{{baseUrl}}" ], "path": [ "payment_options", ":paymentOptionId" ], "variable": [ { "key": "paymentOptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-936720e1-ff3b-4f3f-967d-d48104afb7d2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bb7f678d-e42f-442e-a8d5-0237d6c827ea" } ], "id": "65a9a689-39c5-4153-9ef7-33ec6aa77efd", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-65a9a689-39c5-4153-9ef7-33ec6aa77efd" }, { "name": "List all payment options", "id": "28fa9edc-3f1c-481f-8fbb-f43c0a8942f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/payment_options", "host": [ "{{baseUrl}}" ], "path": [ "payment_options" ] }, "description": "List all payment options" }, "response": [ { "id": "b839b43d-a81d-41c3-b202-3c168e82c369", "name": "A list of payment option objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_options", "host": [ "{{baseUrl}}" ], "path": [ "payment_options" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"adyen_payments\",\n \"data\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"paypal_payments\",\n \"data\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b839b43d-a81d-41c3-b202-3c168e82c369" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-28fa9edc-3f1c-481f-8fbb-f43c0a8942f9" }, { "name": "Create a payment option", "id": "08d5f8f7-e7d4-4b24-95f7-3472c8a4ce17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_options\",\n \"attributes\": {\n \"payment_source_type\": \"external_payments\",\n \"data\": {},\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_options", "host": [ "{{baseUrl}}" ], "path": [ "payment_options" ] }, "description": "Create a payment option" }, "response": [ { "id": "a357dbe7-79c7-430a-9dfa-098da7ab123d", "name": "The created payment option object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"payment_options\",\n \"attributes\": {\n \"payment_source_type\": \"external_payments\",\n \"data\": {},\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_options", "host": [ "{{baseUrl}}" ], "path": [ "payment_options" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"payment_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"payment_source_type\": \"satispay_payments\",\n \"data\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a357dbe7-79c7-430a-9dfa-098da7ab123d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-08d5f8f7-e7d4-4b24-95f7-3472c8a4ce17" } ], "id": "804fecda-e576-46b2-9da2-f5a2d3f20680", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-804fecda-e576-46b2-9da2-f5a2d3f20680" }, { "name": "paypal_gateways", "item": [ { "name": "{paypalGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the paypal gateway", "id": "554d889b-00e7-486c-b389-4eb71e4474bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId", "payment_methods" ], "variable": [ { "id": "0b92090b-d94d-461c-914e-b1d05c5f2833", "key": "paypalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the paypal gateway" }, "response": [ { "id": "98301bc6-bd55-4234-86a9-7a7dd606f637", "name": "The payment_methods associated to the paypal gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId", "payment_methods" ], "variable": [ { "key": "paypalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-98301bc6-bd55-4234-86a9-7a7dd606f637" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-554d889b-00e7-486c-b389-4eb71e4474bb" } ], "id": "e13ac61f-5f1d-41f2-8986-c486f5dc299e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e13ac61f-5f1d-41f2-8986-c486f5dc299e" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the paypal gateway", "id": "0a723920-4e08-4485-85ef-5452dd6ff1a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId", "event_stores" ], "variable": [ { "id": "d26cc0c0-6ddb-45e4-9159-ae678cc07bfb", "key": "paypalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the paypal gateway" }, "response": [ { "id": "5aee7945-c899-4d21-9f04-f27e93bb4de3", "name": "The event_stores associated to the paypal gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId", "event_stores" ], "variable": [ { "key": "paypalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5aee7945-c899-4d21-9f04-f27e93bb4de3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0a723920-4e08-4485-85ef-5452dd6ff1a9" } ], "id": "f5908c66-5692-468a-8a8a-cb1e325f0ea9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f5908c66-5692-468a-8a8a-cb1e325f0ea9" }, { "name": "paypal_payments", "item": [ { "name": "Retrieve the paypal payments associated to the paypal gateway", "id": "83bac58a-feea-41b8-9e80-4eb427a98835", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId/paypal_payments", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId", "paypal_payments" ], "variable": [ { "id": "5622d10d-c86d-4622-a116-0a2179036e5a", "key": "paypalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the paypal payments associated to the paypal gateway" }, "response": [ { "id": "c4af1128-30bd-44a5-8010-42a12ca463a4", "name": "The paypal_payments associated to the paypal gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId/paypal_payments", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId", "paypal_payments" ], "variable": [ { "key": "paypalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c4af1128-30bd-44a5-8010-42a12ca463a4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83bac58a-feea-41b8-9e80-4eb427a98835" } ], "id": "3f516325-e3b0-400b-94c9-27aebf48a8ba", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3f516325-e3b0-400b-94c9-27aebf48a8ba" }, { "name": "Retrieve a paypal gateway", "id": "b59dd2ef-b0c1-4170-88a0-fe807fe4b052", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId" ], "variable": [ { "id": "3d8ac170-b5c0-4f82-b054-5b42217eb76c", "key": "paypalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a paypal gateway" }, "response": [ { "id": "6e9e47ad-9055-40f7-b5ce-76a817a236b7", "name": "The paypal gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId" ], "variable": [ { "key": "paypalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"paypal_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"paypal_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6e9e47ad-9055-40f7-b5ce-76a817a236b7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b59dd2ef-b0c1-4170-88a0-fe807fe4b052" }, { "name": "Update a paypal gateway", "id": "8a6800ba-4b8e-4ba8-8b5c-1ac63e9bc832", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId" ], "variable": [ { "id": "25b420ed-8a60-4789-a416-3a59466e988e", "key": "paypalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a paypal gateway" }, "response": [ { "id": "6052ea6b-0b7c-414a-be0e-e8e9d0987efb", "name": "The updated paypal gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId" ], "variable": [ { "key": "paypalGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"paypal_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"paypal_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6052ea6b-0b7c-414a-be0e-e8e9d0987efb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8a6800ba-4b8e-4ba8-8b5c-1ac63e9bc832" }, { "name": "Delete a paypal gateway", "id": "bcf3319c-5593-4992-9fb5-ceb957f121b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId" ], "variable": [ { "id": "8b451441-7cbf-40f1-a0ae-9b925bc9729e", "key": "paypalGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a paypal gateway" }, "response": [ { "id": "b2157ccd-ee24-4929-8860-535d96ad978b", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_gateways/:paypalGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways", ":paypalGatewayId" ], "variable": [ { "key": "paypalGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b2157ccd-ee24-4929-8860-535d96ad978b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bcf3319c-5593-4992-9fb5-ceb957f121b1" } ], "id": "7b56e4f0-1362-4624-894d-fe0b509fca8b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7b56e4f0-1362-4624-894d-fe0b509fca8b" }, { "name": "List all paypal gateways", "id": "fb2ce2de-08a7-4098-aaa6-79a2a87d289e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/paypal_gateways", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways" ] }, "description": "List all paypal gateways" }, "response": [ { "id": "d20156ff-ebb4-4a8e-ac9c-6f27f96c4c16", "name": "A list of paypal gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_gateways", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"paypal_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"paypal_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"paypal_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"paypal_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d20156ff-ebb4-4a8e-ac9c-6f27f96c4c16" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb2ce2de-08a7-4098-aaa6-79a2a87d289e" }, { "name": "Create a paypal gateway", "id": "ba85c460-e685-4d21-bf1a-556e93fceac7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_gateways", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways" ] }, "description": "Create a paypal gateway" }, "response": [ { "id": "1dd4b9d5-2963-4b73-9c16-8cd8314a29f7", "name": "The created paypal gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_gateways", "host": [ "{{baseUrl}}" ], "path": [ "paypal_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"paypal_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"paypal_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1dd4b9d5-2963-4b73-9c16-8cd8314a29f7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba85c460-e685-4d21-bf1a-556e93fceac7" } ], "id": "62734725-ae54-4aa8-b842-d5cdc318de23", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-62734725-ae54-4aa8-b842-d5cdc318de23" }, { "name": "paypal_payments", "item": [ { "name": "{paypalPaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the paypal payment", "id": "1f51277a-cfb3-4934-bebd-49e58f691b9c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId", "order" ], "variable": [ { "id": "627addc3-a38a-4fb9-8730-43b3df92a7b8", "key": "paypalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the paypal payment" }, "response": [ { "id": "543fc14a-817d-4265-a843-5be86c280bc0", "name": "The order associated to the paypal payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId", "order" ], "variable": [ { "key": "paypalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-543fc14a-817d-4265-a843-5be86c280bc0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1f51277a-cfb3-4934-bebd-49e58f691b9c" } ], "id": "de03cd82-c569-4dfe-898b-3aa79f545f49", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-de03cd82-c569-4dfe-898b-3aa79f545f49" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the paypal payment", "id": "619666eb-9640-419e-97cc-ec5f95e19469", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId", "payment_gateway" ], "variable": [ { "id": "f6875237-47b1-4f03-8a8a-7b2b6b9b3434", "key": "paypalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the paypal payment" }, "response": [ { "id": "e34e5544-823d-4229-9457-b5d86435417a", "name": "The payment_gateway associated to the paypal payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId", "payment_gateway" ], "variable": [ { "key": "paypalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e34e5544-823d-4229-9457-b5d86435417a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-619666eb-9640-419e-97cc-ec5f95e19469" } ], "id": "8d7acfe0-0fa4-41ff-a43a-0b39d291f9f4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8d7acfe0-0fa4-41ff-a43a-0b39d291f9f4" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the paypal payment", "id": "03e77967-b322-4596-9969-b250c995e4a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId", "event_stores" ], "variable": [ { "id": "c715d202-d9c6-4595-b528-d9cabb545a06", "key": "paypalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the paypal payment" }, "response": [ { "id": "a58efd48-969b-4995-85ea-9f37db6eea57", "name": "The event_stores associated to the paypal payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId", "event_stores" ], "variable": [ { "key": "paypalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a58efd48-969b-4995-85ea-9f37db6eea57" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-03e77967-b322-4596-9969-b250c995e4a8" } ], "id": "982b2ef5-671c-42d9-af18-a77c0fa68a2e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-982b2ef5-671c-42d9-af18-a77c0fa68a2e" }, { "name": "Retrieve a paypal payment", "id": "0464a232-1745-415e-8635-2200b518078e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId" ], "variable": [ { "id": "885f7e80-abc8-4d75-9cf4-89352423d9eb", "key": "paypalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a paypal payment" }, "response": [ { "id": "5743201c-1af0-4967-a132-dc9bf79d41df", "name": "The paypal payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId" ], "variable": [ { "key": "paypalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"paypal_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"paypal_payer_id\": \"\",\n \"name\": \"\",\n \"paypal_id\": \"\",\n \"status\": \"approved\",\n \"approval_url\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5743201c-1af0-4967-a132-dc9bf79d41df" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0464a232-1745-415e-8635-2200b518078e" }, { "name": "Update a paypal payment", "id": "abafcce5-377a-4fcd-802c-46e628d5c518", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"paypal_payer_id\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId" ], "variable": [ { "id": "0811aedf-6de2-4b6b-bf4c-e405fb160a69", "key": "paypalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a paypal payment" }, "response": [ { "id": "57c70eb5-7c06-4ae6-993c-0377437028c3", "name": "The updated paypal payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"paypal_payer_id\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId" ], "variable": [ { "key": "paypalPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"paypal_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"paypal_payer_id\": \"\",\n \"name\": \"\",\n \"paypal_id\": \"\",\n \"status\": \"approved\",\n \"approval_url\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-57c70eb5-7c06-4ae6-993c-0377437028c3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-abafcce5-377a-4fcd-802c-46e628d5c518" }, { "name": "Delete a paypal payment", "id": "a8f51f03-99df-425f-b4f6-a46513718656", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId" ], "variable": [ { "id": "ac09fa02-eb65-4e0d-b897-59c339ae273c", "key": "paypalPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a paypal payment" }, "response": [ { "id": "5d17e933-4328-458d-8d13-fafac952b006", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_payments/:paypalPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments", ":paypalPaymentId" ], "variable": [ { "key": "paypalPaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5d17e933-4328-458d-8d13-fafac952b006" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8f51f03-99df-425f-b4f6-a46513718656" } ], "id": "1192dbbb-b381-4520-b16f-cb60acf5be98", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1192dbbb-b381-4520-b16f-cb60acf5be98" }, { "name": "List all paypal payments", "id": "5b552f6a-74c6-4305-aff9-89ce3e0c6c46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/paypal_payments", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments" ] }, "description": "List all paypal payments" }, "response": [ { "id": "827c49cd-dbf1-4ede-b7be-f4aa86a686b2", "name": "A list of paypal payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/paypal_payments", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"paypal_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"paypal_payer_id\": \"\",\n \"name\": \"\",\n \"paypal_id\": \"\",\n \"status\": \"created\",\n \"approval_url\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"paypal_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"paypal_payer_id\": \"\",\n \"name\": \"\",\n \"paypal_id\": \"\",\n \"status\": \"approved\",\n \"approval_url\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-827c49cd-dbf1-4ede-b7be-f4aa86a686b2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5b552f6a-74c6-4305-aff9-89ce3e0c6c46" }, { "name": "Create a paypal payment", "id": "6b9fbc5f-94b8-4e56-9692-0f0866e6c7f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_payments\",\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_payments", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments" ] }, "description": "Create a paypal payment" }, "response": [ { "id": "c6a9c077-91a1-4470-a65b-27b5c04e2438", "name": "The created paypal payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"paypal_payments\",\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/paypal_payments", "host": [ "{{baseUrl}}" ], "path": [ "paypal_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"paypal_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"return_url\": \"\",\n \"cancel_url\": \"\",\n \"note_to_payer\": \"\",\n \"paypal_payer_id\": \"\",\n \"name\": \"\",\n \"paypal_id\": \"\",\n \"status\": \"approved\",\n \"approval_url\": \"\",\n \"mismatched_amounts\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c6a9c077-91a1-4470-a65b-27b5c04e2438" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6b9fbc5f-94b8-4e56-9692-0f0866e6c7f2" } ], "id": "c1e9cc3f-f53e-43a3-ae41-b7fceb67ce95", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c1e9cc3f-f53e-43a3-ae41-b7fceb67ce95" }, { "name": "percentage_discount_promotions", "item": [ { "name": "{percentageDiscountPromotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the percentage discount promotion", "id": "f366f0eb-1b2a-4662-bf5d-f43b673bafa9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "market" ], "variable": [ { "id": "b6ac4a1c-cd8d-4a73-a4ea-fa98576d36ff", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the percentage discount promotion" }, "response": [ { "id": "81e98d82-1932-424d-a403-3fb3e7e3f934", "name": "The market associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "market" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-81e98d82-1932-424d-a403-3fb3e7e3f934" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f366f0eb-1b2a-4662-bf5d-f43b673bafa9" } ], "id": "2df72867-11d6-445b-8338-0f1af23af827", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2df72867-11d6-445b-8338-0f1af23af827" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the percentage discount promotion", "id": "e259d268-e60e-48bc-9800-132f532c4020", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "d2589e43-ce4d-4186-a0bc-a07280d87004", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the percentage discount promotion" }, "response": [ { "id": "001ee700-9d94-422b-8e1e-b6dc853a971f", "name": "The order_amount_promotion_rule associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-001ee700-9d94-422b-8e1e-b6dc853a971f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e259d268-e60e-48bc-9800-132f532c4020" } ], "id": "70330c43-c79b-4c20-ab7c-646c8bb74f4c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-70330c43-c79b-4c20-ab7c-646c8bb74f4c" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the percentage discount promotion", "id": "7773e90d-b272-4530-bca9-1071bb28deff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "a65ada99-55bb-4b67-ab36-0693d73a5976", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the percentage discount promotion" }, "response": [ { "id": "44d1998c-dea0-4273-bf4f-e1ba3d6f2b0d", "name": "The sku_list_promotion_rule associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-44d1998c-dea0-4273-bf4f-e1ba3d6f2b0d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7773e90d-b272-4530-bca9-1071bb28deff" } ], "id": "ea6003e3-8eb2-4f8d-b6b5-b379ee74d29b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ea6003e3-8eb2-4f8d-b6b5-b379ee74d29b" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the percentage discount promotion", "id": "9e8863e6-d43e-4d04-b489-d7313e760d7e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "be964468-f2de-4b34-9965-6ab1f054612b", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the percentage discount promotion" }, "response": [ { "id": "e3ccc1ee-2ec8-45f3-8ae3-555605d677b6", "name": "The coupon_codes_promotion_rule associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3ccc1ee-2ec8-45f3-8ae3-555605d677b6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9e8863e6-d43e-4d04-b489-d7313e760d7e" } ], "id": "b85276ae-15ca-46d8-b84d-d2c81ebd1056", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b85276ae-15ca-46d8-b84d-d2c81ebd1056" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the percentage discount promotion", "id": "3142b98e-cc1f-453f-be3f-fcf2efa982b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "custom_promotion_rule" ], "variable": [ { "id": "11e4ac9c-370f-46ce-bd55-31def7ecea94", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the percentage discount promotion" }, "response": [ { "id": "0827e6d1-a3df-442e-89df-ad098c8df05c", "name": "The custom_promotion_rule associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "custom_promotion_rule" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0827e6d1-a3df-442e-89df-ad098c8df05c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3142b98e-cc1f-453f-be3f-fcf2efa982b1" } ], "id": "8336bb11-a08b-424e-ad67-e52813d532e7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8336bb11-a08b-424e-ad67-e52813d532e7" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the percentage discount promotion", "id": "b4b122f4-4f60-4cbd-ac0a-1d243c19fe98", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "sku_list" ], "variable": [ { "id": "a874843a-fee6-42d6-9a98-25b135d39dec", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the percentage discount promotion" }, "response": [ { "id": "fda4793e-c99d-43d5-91bd-5b4223252fb7", "name": "The sku_list associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "sku_list" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fda4793e-c99d-43d5-91bd-5b4223252fb7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b4b122f4-4f60-4cbd-ac0a-1d243c19fe98" } ], "id": "1e5ad253-eab0-4524-865f-870f5782e67c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1e5ad253-eab0-4524-865f-870f5782e67c" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the percentage discount promotion", "id": "36e70bd8-75e9-4e63-b7db-a0501cb20507", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "coupons" ], "variable": [ { "id": "c839d396-d3bb-4120-8f15-b10feb810e31", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the percentage discount promotion" }, "response": [ { "id": "adc24db8-957d-4be4-846d-1532dd801549", "name": "The coupons associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "coupons" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-adc24db8-957d-4be4-846d-1532dd801549" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-36e70bd8-75e9-4e63-b7db-a0501cb20507" } ], "id": "673f7554-3eda-42fe-ad7e-eed130821cc6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-673f7554-3eda-42fe-ad7e-eed130821cc6" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the percentage discount promotion", "id": "095cecc7-71e6-4af0-a6d2-cd444a41a6c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "attachments" ], "variable": [ { "id": "d01bc3df-3314-442a-89e6-279f67d1537a", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the percentage discount promotion" }, "response": [ { "id": "86834d96-4fce-4b7a-9ed3-8797c6b534c4", "name": "The attachments associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "attachments" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-86834d96-4fce-4b7a-9ed3-8797c6b534c4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-095cecc7-71e6-4af0-a6d2-cd444a41a6c1" } ], "id": "7f3e4ce2-fcb2-4758-afd0-2fbf79f0a494", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7f3e4ce2-fcb2-4758-afd0-2fbf79f0a494" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the percentage discount promotion", "id": "952fa6d5-b8bd-4243-85a9-97d12f05f3d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "events" ], "variable": [ { "id": "6f6c1215-570a-4488-b36c-e4a7809ed434", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the percentage discount promotion" }, "response": [ { "id": "4e236955-3f14-4b1a-ae91-654570dee2bd", "name": "The events associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "events" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4e236955-3f14-4b1a-ae91-654570dee2bd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-952fa6d5-b8bd-4243-85a9-97d12f05f3d0" } ], "id": "12253ed3-9559-4e79-bcb9-eaa54cef86f6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-12253ed3-9559-4e79-bcb9-eaa54cef86f6" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the percentage discount promotion", "id": "d57b1aba-8a70-4341-a90f-60387b25b16d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "tags" ], "variable": [ { "id": "93c361fd-1830-4659-8593-6450c214c0a4", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the percentage discount promotion" }, "response": [ { "id": "39a5992d-85ae-43e1-be97-d7c3cefa8370", "name": "The tags associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "tags" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-39a5992d-85ae-43e1-be97-d7c3cefa8370" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d57b1aba-8a70-4341-a90f-60387b25b16d" } ], "id": "08f1b2b5-145b-4f41-ae55-2b04ec5a8c80", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-08f1b2b5-145b-4f41-ae55-2b04ec5a8c80" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the percentage discount promotion", "id": "d59f5b59-f817-41d1-82a3-22d97cd19820", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "event_stores" ], "variable": [ { "id": "093d68da-a832-49bf-990f-ee528d69879e", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the percentage discount promotion" }, "response": [ { "id": "ec3b98a0-3add-4a13-b630-91a21b865a96", "name": "The event_stores associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "event_stores" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ec3b98a0-3add-4a13-b630-91a21b865a96" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d59f5b59-f817-41d1-82a3-22d97cd19820" } ], "id": "076b0e91-0ec0-4e88-bf04-156e383fe4ec", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-076b0e91-0ec0-4e88-bf04-156e383fe4ec" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the percentage discount promotion", "id": "b12946d7-d84c-4938-9a2c-0c9ef73aacca", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "skus" ], "variable": [ { "id": "27745d1c-0593-46c6-adde-a17df23d33c4", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the percentage discount promotion" }, "response": [ { "id": "e3730d24-bcf2-4e1d-9734-566650cde1c0", "name": "The skus associated to the percentage discount promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId/skus", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId", "skus" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3730d24-bcf2-4e1d-9734-566650cde1c0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b12946d7-d84c-4938-9a2c-0c9ef73aacca" } ], "id": "cb6a62f7-f5c3-4b19-8fa4-7db006002678", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cb6a62f7-f5c3-4b19-8fa4-7db006002678" }, { "name": "Retrieve a percentage discount promotion", "id": "e815353b-0e98-4370-8884-b136861770ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId" ], "variable": [ { "id": "d1826ac4-eada-4f8b-abbe-5cc451346b8a", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a percentage discount promotion" }, "response": [ { "id": "17ad2cd5-3d3f-4ad2-93c8-3d95154be514", "name": "The percentage discount promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-17ad2cd5-3d3f-4ad2-93c8-3d95154be514" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e815353b-0e98-4370-8884-b136861770ee" }, { "name": "Update a percentage discount promotion", "id": "a6a04f90-957e-4913-9907-e0dbeb2d3688", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId" ], "variable": [ { "id": "80d0e6a9-2394-4fbb-a06d-48bde32ec02b", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a percentage discount promotion" }, "response": [ { "id": "bdacb8b9-d57f-441b-9fa8-e628ea097b89", "name": "The updated percentage discount promotion object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bdacb8b9-d57f-441b-9fa8-e628ea097b89" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a6a04f90-957e-4913-9907-e0dbeb2d3688" }, { "name": "Delete a percentage discount promotion", "id": "afd5e208-c8be-494b-9b82-73e26144fd8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId" ], "variable": [ { "id": "1156638e-cd24-4b6f-947c-56d1b516952a", "key": "percentageDiscountPromotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a percentage discount promotion" }, "response": [ { "id": "0d0dc0cb-7190-4e31-a8d6-354c81f8d6b5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions/:percentageDiscountPromotionId", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions", ":percentageDiscountPromotionId" ], "variable": [ { "key": "percentageDiscountPromotionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0d0dc0cb-7190-4e31-a8d6-354c81f8d6b5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-afd5e208-c8be-494b-9b82-73e26144fd8a" } ], "id": "8bb833f1-764f-4fbc-9aad-1491a92959f9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8bb833f1-764f-4fbc-9aad-1491a92959f9" }, { "name": "List all percentage discount promotions", "id": "1e512d19-969f-4483-bc9a-ed8d04e43ec0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions" ] }, "description": "List all percentage discount promotions" }, "response": [ { "id": "f59efd4d-4349-44eb-8455-498e8620aca1", "name": "A list of percentage discount promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/percentage_discount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"external_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f59efd4d-4349-44eb-8455-498e8620aca1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1e512d19-969f-4483-bc9a-ed8d04e43ec0" }, { "name": "Create a percentage discount promotion", "id": "2abc8cbe-d606-4237-9d89-f62aca500215", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"percentage\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/percentage_discount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions" ] }, "description": "Create a percentage discount promotion" }, "response": [ { "id": "d04effec-7372-4c5d-bcb1-6cf9499fc0fa", "name": "The created percentage discount promotion object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"percentage\": \"\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"total_usage_limit\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/percentage_discount_promotions", "host": [ "{{baseUrl}}" ], "path": [ "percentage_discount_promotions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"percentage_discount_promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"inactive\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d04effec-7372-4c5d-bcb1-6cf9499fc0fa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2abc8cbe-d606-4237-9d89-f62aca500215" } ], "id": "9dc15176-5ba6-4bbc-936a-ed3c3179b41d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9dc15176-5ba6-4bbc-936a-ed3c3179b41d" }, { "name": "pickups", "item": [ { "name": "{pickupId}", "item": [ { "name": "shipment", "item": [ { "name": "Retrieve the shipment associated to the pickup", "id": "b13613db-f5de-40d4-bbc9-7d43a5daebb3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "shipment" ], "variable": [ { "id": "43f166e5-9d83-43f9-840c-d355f7c71dae", "key": "pickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipment associated to the pickup" }, "response": [ { "id": "2ae9a390-5fb0-458a-b843-fa7e0e5bbe8d", "name": "The shipment associated to the pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "shipment" ], "variable": [ { "key": "pickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2ae9a390-5fb0-458a-b843-fa7e0e5bbe8d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b13613db-f5de-40d4-bbc9-7d43a5daebb3" } ], "id": "10be73e7-5f71-4b8e-9ae5-f5d4aef0556e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-10be73e7-5f71-4b8e-9ae5-f5d4aef0556e" }, { "name": "parcels", "item": [ { "name": "Retrieve the parcels associated to the pickup", "id": "e498ea98-0692-44c2-ac80-751bcfc357a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "parcels" ], "variable": [ { "id": "991da513-70fd-4f70-b610-f7e7cf2a2218", "key": "pickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the parcels associated to the pickup" }, "response": [ { "id": "ebc6ede9-4d99-4d2a-900e-3da696ed138f", "name": "The parcels associated to the pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "parcels" ], "variable": [ { "key": "pickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ebc6ede9-4d99-4d2a-900e-3da696ed138f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e498ea98-0692-44c2-ac80-751bcfc357a3" } ], "id": "fa0cc326-1bfb-498a-aefb-2860276e0c04", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fa0cc326-1bfb-498a-aefb-2860276e0c04" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the pickup", "id": "f3dc3be9-e6fb-4912-b6db-2e06c2c2bb6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/events", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "events" ], "variable": [ { "id": "7f34fba0-984a-4f45-8d5d-e19bc648fe91", "key": "pickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the pickup" }, "response": [ { "id": "70870a32-cff3-4d36-a5e8-dbdbcd88160a", "name": "The events associated to the pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/events", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "events" ], "variable": [ { "key": "pickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-70870a32-cff3-4d36-a5e8-dbdbcd88160a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f3dc3be9-e6fb-4912-b6db-2e06c2c2bb6e" } ], "id": "b771ac92-c1c4-4444-85bd-6413099cc198", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b771ac92-c1c4-4444-85bd-6413099cc198" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the pickup", "id": "8dc866d6-ac28-46b2-a5ed-a4f5d66a0337", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "event_stores" ], "variable": [ { "id": "deac3564-ab83-4165-bbfc-348f95aa4730", "key": "pickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the pickup" }, "response": [ { "id": "74087e0f-aef5-4e70-9e77-6bef7edf7f2e", "name": "The event_stores associated to the pickup", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/pickups/:pickupId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId", "event_stores" ], "variable": [ { "key": "pickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-74087e0f-aef5-4e70-9e77-6bef7edf7f2e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8dc866d6-ac28-46b2-a5ed-a4f5d66a0337" } ], "id": "9f086152-e69a-4b5b-9110-50a136905326", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9f086152-e69a-4b5b-9110-50a136905326" }, { "name": "Retrieve a pickup", "id": "9c419e13-e8b1-485c-ad9c-42cd4fe707b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/pickups/:pickupId", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId" ], "variable": [ { "id": "b46a1080-2595-47f7-a31b-8d557b617133", "key": "pickupId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a pickup" }, "response": [ { "id": "076e22da-2313-4ca0-9480-4064c454c23d", "name": "The pickup object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/pickups/:pickupId", "host": [ "{{baseUrl}}" ], "path": [ "pickups", ":pickupId" ], "variable": [ { "key": "pickupId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-076e22da-2313-4ca0-9480-4064c454c23d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9c419e13-e8b1-485c-ad9c-42cd4fe707b6" } ], "id": "39b10dde-754f-4c21-8271-da4601e01bfd", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-39b10dde-754f-4c21-8271-da4601e01bfd" }, { "name": "List all pickups", "id": "a48a3e39-2730-4112-933f-069340f6d8a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/pickups", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ] }, "description": "List all pickups" }, "response": [ { "id": "2397f839-3830-4618-81b3-1a2b27366725", "name": "A list of pickup objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/pickups", "host": [ "{{baseUrl}}" ], "path": [ "pickups" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"pickups\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"easypost_pickups\",\n \"status\": \"\",\n \"internal_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2397f839-3830-4618-81b3-1a2b27366725" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a48a3e39-2730-4112-933f-069340f6d8a1" } ], "id": "6aa117c7-b5bf-4f03-99b3-37ab08b293c9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6aa117c7-b5bf-4f03-99b3-37ab08b293c9" }, { "name": "price_frequency_tiers", "item": [ { "name": "{priceFrequencyTierId}", "item": [ { "name": "price", "item": [ { "name": "Retrieve the price associated to the price frequency tier", "id": "8cf411ea-96e3-4a68-b991-e41e1ce58412", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/price", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "price" ], "variable": [ { "id": "f2acf323-469d-43c5-98f9-8f51d4683cd2", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price associated to the price frequency tier" }, "response": [ { "id": "6450f5ed-4a49-41bd-b9d6-e2778cfa1f72", "name": "The price associated to the price frequency tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/price", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "price" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6450f5ed-4a49-41bd-b9d6-e2778cfa1f72" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8cf411ea-96e3-4a68-b991-e41e1ce58412" } ], "id": "e4d7ea89-5989-4e14-b8ae-53cca8631028", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e4d7ea89-5989-4e14-b8ae-53cca8631028" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the price frequency tier", "id": "5ab864e7-a57a-40a9-849e-a93f00386b35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "attachments" ], "variable": [ { "id": "7e2ac5f2-6e06-444c-bfc5-b8d3d85b5553", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the price frequency tier" }, "response": [ { "id": "be085a87-d4cc-480e-9bff-cebe0cf8f9d8", "name": "The attachments associated to the price frequency tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "attachments" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-be085a87-d4cc-480e-9bff-cebe0cf8f9d8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5ab864e7-a57a-40a9-849e-a93f00386b35" } ], "id": "eb568445-2d8b-4997-b17b-a40bea604340", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-eb568445-2d8b-4997-b17b-a40bea604340" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the price frequency tier", "id": "d6dfdfc3-e950-495c-b96d-c02c3451aec4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "event_stores" ], "variable": [ { "id": "af2984d0-65cc-4a58-825a-75f06b1b02be", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the price frequency tier" }, "response": [ { "id": "6974595c-4b60-494c-834b-a7052dce53ab", "name": "The event_stores associated to the price frequency tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "event_stores" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6974595c-4b60-494c-834b-a7052dce53ab" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d6dfdfc3-e950-495c-b96d-c02c3451aec4" } ], "id": "42589406-d5cc-48cf-8c48-d95e1b65d6a2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-42589406-d5cc-48cf-8c48-d95e1b65d6a2" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the price frequency tier", "id": "14ee9928-99f8-4b36-a61f-387d4a97626c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/events", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "events" ], "variable": [ { "id": "3e3c0101-6031-49c6-8e39-a6a3491f740f", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the price frequency tier" }, "response": [ { "id": "65b9607c-1391-4026-8f66-8ef29c9fb6ef", "name": "The events associated to the price frequency tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId/events", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId", "events" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-65b9607c-1391-4026-8f66-8ef29c9fb6ef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-14ee9928-99f8-4b36-a61f-387d4a97626c" } ], "id": "11a6bbee-fee3-4f68-ab90-d3146ac6f218", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-11a6bbee-fee3-4f68-ab90-d3146ac6f218" }, { "name": "Retrieve a price frequency tier", "id": "5d321830-a855-4855-9d0e-65c6f964cf05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId" ], "variable": [ { "id": "8c77a360-3bcc-4a33-ba04-c5665fad658d", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a price frequency tier" }, "response": [ { "id": "5b14f823-d29f-4611-a016-49e8f24214d2", "name": "The price frequency tier object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5b14f823-d29f-4611-a016-49e8f24214d2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5d321830-a855-4855-9d0e-65c6f964cf05" }, { "name": "Update a price frequency tier", "id": "cf39364d-5461-45f6-b523-8d7321ede31a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId" ], "variable": [ { "id": "fb90955c-9b60-4350-acfa-036df3f7147b", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a price frequency tier" }, "response": [ { "id": "bc87c6d1-f976-4ef1-8c15-634f287e8fba", "name": "The updated price frequency tier object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bc87c6d1-f976-4ef1-8c15-634f287e8fba" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cf39364d-5461-45f6-b523-8d7321ede31a" }, { "name": "Delete a price frequency tier", "id": "e1528fc2-8e23-4087-ba7c-3d7071b3eeb1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId" ], "variable": [ { "id": "de7e61cd-a4de-4be0-8776-f05f53c7c26d", "key": "priceFrequencyTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a price frequency tier" }, "response": [ { "id": "7ca35b5c-4db1-4dc0-b932-50f839ae5886", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers/:priceFrequencyTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers", ":priceFrequencyTierId" ], "variable": [ { "key": "priceFrequencyTierId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7ca35b5c-4db1-4dc0-b932-50f839ae5886" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e1528fc2-8e23-4087-ba7c-3d7071b3eeb1" } ], "id": "0e911951-075b-4819-bf19-80b979afb6b0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0e911951-075b-4819-bf19-80b979afb6b0" }, { "name": "List all price frequency tiers", "id": "2e9a9f34-fe20-4c4d-9c25-e2bffde64d33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers" ] }, "description": "List all price frequency tiers" }, "response": [ { "id": "8f65da47-758e-4e3c-8bec-67a1a5a266d1", "name": "A list of price frequency tier objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_frequency_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8f65da47-758e-4e3c-8bec-67a1a5a266d1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e9a9f34-fe20-4c4d-9c25-e2bffde64d33" }, { "name": "Create a price frequency tier", "id": "58defd1d-29d0-4886-bd1b-1289b3e96525", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"up_to\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_frequency_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers" ] }, "description": "Create a price frequency tier" }, "response": [ { "id": "daed465e-ff4f-4ce2-a852-4ee05a860d85", "name": "The created price frequency tier object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"up_to\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_frequency_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_frequency_tiers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-daed465e-ff4f-4ce2-a852-4ee05a860d85" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-58defd1d-29d0-4886-bd1b-1289b3e96525" } ], "id": "f9bed9e3-9319-4e20-9844-eff4dcc56407", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f9bed9e3-9319-4e20-9844-eff4dcc56407" }, { "name": "price_list_schedulers", "item": [ { "name": "{priceListSchedulerId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the price list scheduler", "id": "ff204609-a33e-4603-a86f-8c0379770575", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/market", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "market" ], "variable": [ { "id": "d6c19832-3001-4e09-9acb-9d46a1768ab6", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the price list scheduler" }, "response": [ { "id": "4c8bf221-eae3-4a85-a806-ec9437a383ba", "name": "The market associated to the price list scheduler", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/market", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "market" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4c8bf221-eae3-4a85-a806-ec9437a383ba" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ff204609-a33e-4603-a86f-8c0379770575" } ], "id": "7d2d5f8c-a52c-403e-9133-adefbc41b8a6", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7d2d5f8c-a52c-403e-9133-adefbc41b8a6" }, { "name": "price_list", "item": [ { "name": "Retrieve the price list associated to the price list scheduler", "id": "52545fcb-2ccc-4b2d-9ac7-825659f62ab2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/price_list", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "price_list" ], "variable": [ { "id": "96a82e93-e273-43db-a79a-47d95c40d312", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price list associated to the price list scheduler" }, "response": [ { "id": "2ba5d775-2954-4bda-9377-36528dadbaa3", "name": "The price_list associated to the price list scheduler", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/price_list", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "price_list" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2ba5d775-2954-4bda-9377-36528dadbaa3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-52545fcb-2ccc-4b2d-9ac7-825659f62ab2" } ], "id": "b3e29dff-ea23-4adc-af69-721e98e1d3d9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b3e29dff-ea23-4adc-af69-721e98e1d3d9" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the price list scheduler", "id": "302c76fa-475f-4244-9725-d87a2dcd7f1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/events", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "events" ], "variable": [ { "id": "3cf16e28-671d-4dc9-a1c4-4c72ded8bf6f", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the price list scheduler" }, "response": [ { "id": "097dc31d-473a-48b1-9173-b6c3d42df441", "name": "The events associated to the price list scheduler", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/events", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "events" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-097dc31d-473a-48b1-9173-b6c3d42df441" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-302c76fa-475f-4244-9725-d87a2dcd7f1c" } ], "id": "7e48e39d-d5f3-495d-958b-970b9a6a03d9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7e48e39d-d5f3-495d-958b-970b9a6a03d9" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the price list scheduler", "id": "68aba7c6-bfd3-4230-af45-96d62d8933b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "event_stores" ], "variable": [ { "id": "644d0374-826b-4e93-9693-a1e5dc19d8e8", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the price list scheduler" }, "response": [ { "id": "c68ec8a3-9077-4667-86af-550c82636fea", "name": "The event_stores associated to the price list scheduler", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId", "event_stores" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c68ec8a3-9077-4667-86af-550c82636fea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-68aba7c6-bfd3-4230-af45-96d62d8933b3" } ], "id": "0b1b0796-71d8-491b-8589-4052522eaf13", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0b1b0796-71d8-491b-8589-4052522eaf13" }, { "name": "Retrieve a price list scheduler", "id": "6260a1ab-955e-405b-9704-ab38845ffe9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId" ], "variable": [ { "id": "2df2cb65-9e42-4f69-82ba-5d337b3fc211", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a price list scheduler" }, "response": [ { "id": "e8f412bd-f943-4e7c-9063-930033de5181", "name": "The price list scheduler object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_list_schedulers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e8f412bd-f943-4e7c-9063-930033de5181" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6260a1ab-955e-405b-9704-ab38845ffe9b" }, { "name": "Update a price list scheduler", "id": "4b826e57-952d-4d85-a2d6-abc27b205a4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId" ], "variable": [ { "id": "770d8616-5ad3-43c2-81de-2de3e8de2d2d", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a price list scheduler" }, "response": [ { "id": "2056934d-9747-4018-8e55-36a4430d4cfc", "name": "The updated price list scheduler object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_list_schedulers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2056934d-9747-4018-8e55-36a4430d4cfc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4b826e57-952d-4d85-a2d6-abc27b205a4f" }, { "name": "Delete a price list scheduler", "id": "ae63ca3a-e0b1-4721-8df7-56cb297b1f89", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId" ], "variable": [ { "id": "dca560b2-ba1d-47b8-91d4-fece370a29cc", "key": "priceListSchedulerId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a price list scheduler" }, "response": [ { "id": "71f0f5b0-465f-44af-b53a-5699f20a9fc9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers/:priceListSchedulerId", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers", ":priceListSchedulerId" ], "variable": [ { "key": "priceListSchedulerId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-71f0f5b0-465f-44af-b53a-5699f20a9fc9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ae63ca3a-e0b1-4721-8df7-56cb297b1f89" } ], "id": "afb29e0e-9dd6-47ce-ab19-d0a74c085289", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-afb29e0e-9dd6-47ce-ab19-d0a74c085289" }, { "name": "List all price list schedulers", "id": "d0bb36bb-5367-4520-8a44-93b58e9ace87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers" ] }, "description": "List all price list schedulers" }, "response": [ { "id": "e051c978-2708-46f2-8129-847aa39de75b", "name": "A list of price list scheduler objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"price_list_schedulers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"price_list_schedulers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"disabled\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e051c978-2708-46f2-8129-847aa39de75b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d0bb36bb-5367-4520-8a44-93b58e9ace87" }, { "name": "Create a price list scheduler", "id": "6246d8bd-b559-4f01-acfc-c9ebf587f30f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers" ] }, "description": "Create a price list scheduler" }, "response": [ { "id": "e79e22de-73a5-4625-9a60-be92e14822b9", "name": "The created price list scheduler object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "price_list_schedulers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_list_schedulers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"active\": \"\",\n \"status\": \"pending\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e79e22de-73a5-4625-9a60-be92e14822b9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6246d8bd-b559-4f01-acfc-c9ebf587f30f" } ], "id": "e3a7b8fa-351b-4778-98bc-6f2f24420f79", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e3a7b8fa-351b-4778-98bc-6f2f24420f79" }, { "name": "price_lists", "item": [ { "name": "{priceListId}", "item": [ { "name": "prices", "item": [ { "name": "Retrieve the prices associated to the price list", "id": "3b3cefdd-6467-4bab-a642-5e9409f71634", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/prices", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "prices" ], "variable": [ { "id": "6db319fb-9ec0-4852-9e39-323d1ab57f41", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the prices associated to the price list" }, "response": [ { "id": "63f96e21-731e-437b-aa84-6045f78a2676", "name": "The prices associated to the price list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/prices", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "prices" ], "variable": [ { "key": "priceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-63f96e21-731e-437b-aa84-6045f78a2676" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3b3cefdd-6467-4bab-a642-5e9409f71634" } ], "id": "ea6e1ca2-b9e9-40de-ae30-14e1f2a05433", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ea6e1ca2-b9e9-40de-ae30-14e1f2a05433" }, { "name": "price_list_schedulers", "item": [ { "name": "Retrieve the price list schedulers associated to the price list", "id": "b6af31fa-864a-46ff-8e73-12400e06660b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "price_list_schedulers" ], "variable": [ { "id": "301728eb-b05c-4fb1-b86f-e25c59604b80", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price list schedulers associated to the price list" }, "response": [ { "id": "dfa58406-b151-4baa-9ae8-73a52105f7ab", "name": "The price_list_schedulers associated to the price list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/price_list_schedulers", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "price_list_schedulers" ], "variable": [ { "key": "priceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dfa58406-b151-4baa-9ae8-73a52105f7ab" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b6af31fa-864a-46ff-8e73-12400e06660b" } ], "id": "d20b3b8b-af58-441c-8f35-8f70de6ce309", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d20b3b8b-af58-441c-8f35-8f70de6ce309" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the price list", "id": "7ffdd212-eda7-4de9-a957-d60c8049094b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "attachments" ], "variable": [ { "id": "9079637c-66f1-4618-a1e9-4237e884a652", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the price list" }, "response": [ { "id": "715a87b1-90d2-4fe4-9760-377dc2ed0b57", "name": "The attachments associated to the price list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "attachments" ], "variable": [ { "key": "priceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-715a87b1-90d2-4fe4-9760-377dc2ed0b57" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7ffdd212-eda7-4de9-a957-d60c8049094b" } ], "id": "d8f20984-c026-46bb-add9-ddbea270847e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d8f20984-c026-46bb-add9-ddbea270847e" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the price list", "id": "1ae0cea5-2d80-435d-8f84-1f2631d74890", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "event_stores" ], "variable": [ { "id": "d8b79dd5-ee50-4089-bc6c-1b0f17de4355", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the price list" }, "response": [ { "id": "5bfced00-b839-4341-932e-b19d39c4a2dc", "name": "The event_stores associated to the price list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId", "event_stores" ], "variable": [ { "key": "priceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5bfced00-b839-4341-932e-b19d39c4a2dc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ae0cea5-2d80-435d-8f84-1f2631d74890" } ], "id": "8c3bf253-138a-44fd-a343-0718f9fbbd28", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8c3bf253-138a-44fd-a343-0718f9fbbd28" }, { "name": "Retrieve a price list", "id": "f5b6cf56-52b3-4bc6-8b1a-03bd4ae078c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId" ], "variable": [ { "id": "730204b2-3492-4c38-a4ed-1579e67b8215", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a price list" }, "response": [ { "id": "3fb709af-8767-4f68-aea9-07a6e0a63782", "name": "The price list object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId" ], "variable": [ { "key": "priceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"rule_outcomes\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3fb709af-8767-4f68-aea9-07a6e0a63782" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f5b6cf56-52b3-4bc6-8b1a-03bd4ae078c5" }, { "name": "Update a price list", "id": "e052ad1f-6c75-41da-919a-71b497fca332", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_lists/:priceListId", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId" ], "variable": [ { "id": "dd507004-04c0-41af-824a-9af0d34d9551", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a price list" }, "response": [ { "id": "60cf933b-b5c0-4813-80f4-71fb0cb59aaf", "name": "The updated price list object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_lists/:priceListId", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId" ], "variable": [ { "key": "priceListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"rule_outcomes\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-60cf933b-b5c0-4813-80f4-71fb0cb59aaf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e052ad1f-6c75-41da-919a-71b497fca332" }, { "name": "Delete a price list", "id": "9889f3a9-0b0e-4f96-b541-ce791d492a13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId" ], "variable": [ { "id": "26518e28-a46b-40a2-932b-9077fabca5ee", "key": "priceListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a price list" }, "response": [ { "id": "2a3b9387-3307-4787-81e1-6eac0a30f85a", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists/:priceListId", "host": [ "{{baseUrl}}" ], "path": [ "price_lists", ":priceListId" ], "variable": [ { "key": "priceListId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2a3b9387-3307-4787-81e1-6eac0a30f85a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9889f3a9-0b0e-4f96-b541-ce791d492a13" } ], "id": "8d6e7c4b-52fd-49c9-8bfd-44cf8f93dfb9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8d6e7c4b-52fd-49c9-8bfd-44cf8f93dfb9" }, { "name": "List all price lists", "id": "1b26ec4b-6e0c-421c-b73a-2a0422a5ba30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_lists", "host": [ "{{baseUrl}}" ], "path": [ "price_lists" ] }, "description": "List all price lists" }, "response": [ { "id": "9113e38a-964d-4b9a-a1fa-fa4056f84f97", "name": "A list of price list objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_lists", "host": [ "{{baseUrl}}" ], "path": [ "price_lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"price_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"rule_outcomes\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"price_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"rule_outcomes\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9113e38a-964d-4b9a-a1fa-fa4056f84f97" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1b26ec4b-6e0c-421c-b73a-2a0422a5ba30" }, { "name": "Create a price list", "id": "20e8a630-ee1d-413d-bce5-8d41c4608188", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_lists\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"code\": \"\",\n \"tax_included\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_lists", "host": [ "{{baseUrl}}" ], "path": [ "price_lists" ] }, "description": "Create a price list" }, "response": [ { "id": "a966257b-bda0-45e0-9b46-bd9b1eb59dca", "name": "The created price list object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_lists\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"code\": \"\",\n \"tax_included\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_lists", "host": [ "{{baseUrl}}" ], "path": [ "price_lists" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"currency_code\": \"\",\n \"tax_included\": \"\",\n \"rule_outcomes\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"price_list_schedulers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list_schedulers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a966257b-bda0-45e0-9b46-bd9b1eb59dca" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-20e8a630-ee1d-413d-bce5-8d41c4608188" } ], "id": "489a357f-2efc-49d7-9244-0237d0492cc7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-489a357f-2efc-49d7-9244-0237d0492cc7" }, { "name": "price_tiers", "item": [ { "name": "{priceTierId}", "item": [ { "name": "price", "item": [ { "name": "Retrieve the price associated to the price tier", "id": "9b1c58bb-9da0-4318-b272-409389150c95", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId/price", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId", "price" ], "variable": [ { "id": "86725436-05ed-4be2-ab27-4853a535ef6e", "key": "priceTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price associated to the price tier" }, "response": [ { "id": "d486534f-9e4d-41a8-b312-54d2954909fa", "name": "The price associated to the price tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId/price", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId", "price" ], "variable": [ { "key": "priceTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d486534f-9e4d-41a8-b312-54d2954909fa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9b1c58bb-9da0-4318-b272-409389150c95" } ], "id": "330d8623-4ec0-4248-9768-eb18933ffa5d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-330d8623-4ec0-4248-9768-eb18933ffa5d" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the price tier", "id": "5986f313-9228-4f48-994a-ba03dd2105a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId", "attachments" ], "variable": [ { "id": "cdf6fa4c-3a61-44cd-9025-97c8ec3e2ad8", "key": "priceTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the price tier" }, "response": [ { "id": "8e0b7a42-d0ce-4218-b8a4-3f4e2fe4c710", "name": "The attachments associated to the price tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId", "attachments" ], "variable": [ { "key": "priceTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8e0b7a42-d0ce-4218-b8a4-3f4e2fe4c710" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5986f313-9228-4f48-994a-ba03dd2105a2" } ], "id": "ce417243-418d-464b-a850-08b680f25897", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ce417243-418d-464b-a850-08b680f25897" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the price tier", "id": "33ea8cf2-3b94-47af-b630-f9a1aba64226", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId", "event_stores" ], "variable": [ { "id": "67c4a14d-b451-402f-a549-4bf7d1d6f8f9", "key": "priceTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the price tier" }, "response": [ { "id": "672438cf-a7cf-4bb0-9cdf-527d449f571f", "name": "The event_stores associated to the price tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId", "event_stores" ], "variable": [ { "key": "priceTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-672438cf-a7cf-4bb0-9cdf-527d449f571f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-33ea8cf2-3b94-47af-b630-f9a1aba64226" } ], "id": "2cf2d42e-a322-40eb-9086-8c33b0d7c172", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2cf2d42e-a322-40eb-9086-8c33b0d7c172" }, { "name": "Retrieve a price tier", "id": "f9c11286-3bb9-4521-93a2-d077654fcd06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId" ], "variable": [ { "id": "a2e0c661-6a32-4e11-9f01-1c45adee01cb", "key": "priceTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a price tier" }, "response": [ { "id": "bdbeebb2-b355-4051-8a52-e1dc5b54e1ea", "name": "The price tier object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_tiers/:priceTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers", ":priceTierId" ], "variable": [ { "key": "priceTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bdbeebb2-b355-4051-8a52-e1dc5b54e1ea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f9c11286-3bb9-4521-93a2-d077654fcd06" } ], "id": "155135bc-bc93-459f-9d99-6a92f9eb288e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-155135bc-bc93-459f-9d99-6a92f9eb288e" }, { "name": "List all price tiers", "id": "98bb44a0-b789-4369-9599-03a42c5ccc39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers" ] }, "description": "List all price tiers" }, "response": [ { "id": "2ab13710-01ab-4341-9e14-44c89341775a", "name": "A list of price tier objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_tiers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"price_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"price_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_volume_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2ab13710-01ab-4341-9e14-44c89341775a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98bb44a0-b789-4369-9599-03a42c5ccc39" } ], "id": "9fc960cc-e96e-4179-8b00-aec3a754d5dc", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9fc960cc-e96e-4179-8b00-aec3a754d5dc" }, { "name": "price_volume_tiers", "item": [ { "name": "{priceVolumeTierId}", "item": [ { "name": "price", "item": [ { "name": "Retrieve the price associated to the price volume tier", "id": "024e92e8-7be1-4f31-9320-ffdf8e8303b1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/price", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "price" ], "variable": [ { "id": "968a0063-50a1-4f04-aaf9-d50831f8e06b", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price associated to the price volume tier" }, "response": [ { "id": "37273a84-7283-4034-b34b-153a5b72d49b", "name": "The price associated to the price volume tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/price", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "price" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-37273a84-7283-4034-b34b-153a5b72d49b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-024e92e8-7be1-4f31-9320-ffdf8e8303b1" } ], "id": "8a07b3af-6bb8-4eab-842a-82fb7fb72101", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8a07b3af-6bb8-4eab-842a-82fb7fb72101" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the price volume tier", "id": "5dac1de7-7216-462e-9455-5126aae34885", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "attachments" ], "variable": [ { "id": "7ad5df92-a31d-4285-90cc-b6bce217ac8a", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the price volume tier" }, "response": [ { "id": "ec4c4144-5495-4d89-a176-41b9a9afc8df", "name": "The attachments associated to the price volume tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "attachments" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ec4c4144-5495-4d89-a176-41b9a9afc8df" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5dac1de7-7216-462e-9455-5126aae34885" } ], "id": "b70e4634-e504-4cce-b8e7-827143aeda2a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b70e4634-e504-4cce-b8e7-827143aeda2a" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the price volume tier", "id": "068566c4-69e1-4df3-9e70-20b25011f840", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "event_stores" ], "variable": [ { "id": "1d40b9ea-228c-448d-8eea-1435c4f21369", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the price volume tier" }, "response": [ { "id": "4b2cd4a2-c7f1-4625-a21a-7658d97d21ff", "name": "The event_stores associated to the price volume tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "event_stores" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4b2cd4a2-c7f1-4625-a21a-7658d97d21ff" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-068566c4-69e1-4df3-9e70-20b25011f840" } ], "id": "67adb326-e796-49f9-aa9a-868325d777ba", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-67adb326-e796-49f9-aa9a-868325d777ba" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the price volume tier", "id": "5411e4c9-b5fb-4cb7-ab28-8fe104d07790", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/events", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "events" ], "variable": [ { "id": "7658cc2d-2936-4c6a-9839-8ca86d083593", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the price volume tier" }, "response": [ { "id": "ce1b6c3a-ee45-4d31-b108-d8692e76f5bb", "name": "The events associated to the price volume tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId/events", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId", "events" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ce1b6c3a-ee45-4d31-b108-d8692e76f5bb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5411e4c9-b5fb-4cb7-ab28-8fe104d07790" } ], "id": "3d4da090-66c5-4806-ad8a-632cb056e0c3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3d4da090-66c5-4806-ad8a-632cb056e0c3" }, { "name": "Retrieve a price volume tier", "id": "64fe9d97-3c55-408b-8ce2-5fdd85d54015", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId" ], "variable": [ { "id": "7a6b4488-fed4-459d-863c-058edde1777a", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a price volume tier" }, "response": [ { "id": "3ac0904a-2b12-4cd3-8142-4ecb1e785326", "name": "The price volume tier object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_volume_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_volume_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3ac0904a-2b12-4cd3-8142-4ecb1e785326" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-64fe9d97-3c55-408b-8ce2-5fdd85d54015" }, { "name": "Update a price volume tier", "id": "915114a2-b68a-4dc9-b3f8-b3359423bdb2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId" ], "variable": [ { "id": "3b0c732b-51fd-4a0e-83de-371be845c2ce", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a price volume tier" }, "response": [ { "id": "472e667e-0ec1-4d9e-a046-b0854c4a6805", "name": "The updated price volume tier object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_volume_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_volume_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-472e667e-0ec1-4d9e-a046-b0854c4a6805" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-915114a2-b68a-4dc9-b3f8-b3359423bdb2" }, { "name": "Delete a price volume tier", "id": "8f55ec8c-1804-4e72-b1af-88decee26d8b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId" ], "variable": [ { "id": "3e5c9618-fc16-4586-b48e-c0d978e14b17", "key": "priceVolumeTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a price volume tier" }, "response": [ { "id": "f1582bde-8216-4ca1-bf57-a9355312ee7f", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers/:priceVolumeTierId", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers", ":priceVolumeTierId" ], "variable": [ { "key": "priceVolumeTierId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f1582bde-8216-4ca1-bf57-a9355312ee7f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8f55ec8c-1804-4e72-b1af-88decee26d8b" } ], "id": "0aa12f52-048e-479f-80c1-ecc7d6d396be", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-0aa12f52-048e-479f-80c1-ecc7d6d396be" }, { "name": "List all price volume tiers", "id": "fc359b68-84e5-47a0-8e3d-7944831ebeee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers" ] }, "description": "List all price volume tiers" }, "response": [ { "id": "0e9ee5a3-2a75-4060-85b7-d6f571d45195", "name": "A list of price volume tier objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/price_volume_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"price_volume_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_frequency_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"price_volume_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_volume_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0e9ee5a3-2a75-4060-85b7-d6f571d45195" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fc359b68-84e5-47a0-8e3d-7944831ebeee" }, { "name": "Create a price volume tier", "id": "8cfc55a4-3cf8-45c1-94aa-e7038d2f1ec4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"up_to\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_volume_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers" ] }, "description": "Create a price volume tier" }, "response": [ { "id": "b5349635-a92e-4e98-8436-6332be521daf", "name": "The created price volume tier object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"up_to\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/price_volume_tiers", "host": [ "{{baseUrl}}" ], "path": [ "price_volume_tiers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"price_volume_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"price_volume_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"price\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b5349635-a92e-4e98-8436-6332be521daf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8cfc55a4-3cf8-45c1-94aa-e7038d2f1ec4" } ], "id": "4762dafc-e136-4409-90c9-4c628d4d6fc7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4762dafc-e136-4409-90c9-4c628d4d6fc7" }, { "name": "prices", "item": [ { "name": "{priceId}", "item": [ { "name": "price_list", "item": [ { "name": "Retrieve the price list associated to the price", "id": "ef4d2037-a338-40d4-a4ad-f1002cf15393", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_list", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_list" ], "variable": [ { "id": "9d5cb014-385a-47d1-a2ef-035ee323f40e", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price list associated to the price" }, "response": [ { "id": "30eaea63-b1e0-4ce0-8be7-603123960d76", "name": "The price_list associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_list", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_list" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-30eaea63-b1e0-4ce0-8be7-603123960d76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ef4d2037-a338-40d4-a4ad-f1002cf15393" } ], "id": "5be5d88c-c47d-4e12-a247-372a317fb3a3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5be5d88c-c47d-4e12-a247-372a317fb3a3" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the price", "id": "02f4aba7-50bc-4fff-a15e-7649b3e8b900", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/sku", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "sku" ], "variable": [ { "id": "b942e86d-0d0e-4638-80c0-c503869ff949", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the price" }, "response": [ { "id": "ddc0019d-4c39-4727-965a-910cb3e5c596", "name": "The sku associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/sku", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "sku" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ddc0019d-4c39-4727-965a-910cb3e5c596" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-02f4aba7-50bc-4fff-a15e-7649b3e8b900" } ], "id": "a0255151-5dba-4793-8ece-acd64010a3e1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a0255151-5dba-4793-8ece-acd64010a3e1" }, { "name": "price_tiers", "item": [ { "name": "Retrieve the price tiers associated to the price", "id": "0060ff4b-27c9-4dbb-b930-c688c101876a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_tiers", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_tiers" ], "variable": [ { "id": "0c5d88c0-e096-4348-9a82-142070064968", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price tiers associated to the price" }, "response": [ { "id": "71d9a8ee-c7f9-4d0c-8913-115bea8a0515", "name": "The price_tiers associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_tiers", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_tiers" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-71d9a8ee-c7f9-4d0c-8913-115bea8a0515" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0060ff4b-27c9-4dbb-b930-c688c101876a" } ], "id": "52945540-e9ac-4f6f-8760-32780620de7c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-52945540-e9ac-4f6f-8760-32780620de7c" }, { "name": "price_volume_tiers", "item": [ { "name": "Retrieve the price volume tiers associated to the price", "id": "86864c19-01ae-4185-9051-5c2faa14c9d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_volume_tiers", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_volume_tiers" ], "variable": [ { "id": "6b62a86b-14bd-4190-80ea-ac23854e1568", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price volume tiers associated to the price" }, "response": [ { "id": "c7ee9349-3e0f-4551-935f-b3f70994c2db", "name": "The price_volume_tiers associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_volume_tiers", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_volume_tiers" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c7ee9349-3e0f-4551-935f-b3f70994c2db" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-86864c19-01ae-4185-9051-5c2faa14c9d1" } ], "id": "89c835d7-c17f-4c1c-a2a8-4a754bb64554", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-89c835d7-c17f-4c1c-a2a8-4a754bb64554" }, { "name": "price_frequency_tiers", "item": [ { "name": "Retrieve the price frequency tiers associated to the price", "id": "22e08936-0a03-4eb2-9ca1-b05cf231d1dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_frequency_tiers", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_frequency_tiers" ], "variable": [ { "id": "454c5f8c-1a4d-4e12-8ce4-72d6a774a6af", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the price frequency tiers associated to the price" }, "response": [ { "id": "520a27f8-7750-4276-a0ab-8bf2e4864668", "name": "The price_frequency_tiers associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/price_frequency_tiers", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "price_frequency_tiers" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-520a27f8-7750-4276-a0ab-8bf2e4864668" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-22e08936-0a03-4eb2-9ca1-b05cf231d1dc" } ], "id": "e839cf58-34ce-446a-ad28-de482cc1db44", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e839cf58-34ce-446a-ad28-de482cc1db44" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the price", "id": "fe55bb74-9c20-4f9a-9d3f-afc15e794b0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "attachments" ], "variable": [ { "id": "980c92dd-9370-4b74-ae17-14e1f89fe7d9", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the price" }, "response": [ { "id": "893c96ff-9021-4303-8811-b9f2d469957b", "name": "The attachments associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "attachments" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-893c96ff-9021-4303-8811-b9f2d469957b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fe55bb74-9c20-4f9a-9d3f-afc15e794b0d" } ], "id": "811fe594-3016-4e4e-bf38-2176ef257738", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-811fe594-3016-4e4e-bf38-2176ef257738" }, { "name": "jwt_customer", "item": [ { "name": "Retrieve the jwt customer associated to the price", "id": "8a64d58c-77bb-4ac8-96d1-6d340c505f35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/jwt_customer", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "jwt_customer" ], "variable": [ { "id": "d918c93d-f809-46a2-b2c9-6c6ac07872ea", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt customer associated to the price" }, "response": [ { "id": "78803751-fa9e-43ce-8d6b-dc59181c8d56", "name": "The jwt_customer associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/jwt_customer", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "jwt_customer" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-78803751-fa9e-43ce-8d6b-dc59181c8d56" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8a64d58c-77bb-4ac8-96d1-6d340c505f35" } ], "id": "773b999e-2fec-4210-acb9-ef10d23706af", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-773b999e-2fec-4210-acb9-ef10d23706af" }, { "name": "jwt_markets", "item": [ { "name": "Retrieve the jwt markets associated to the price", "id": "2fcea239-f003-4d7a-a10c-981d61a0f971", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/jwt_markets", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "jwt_markets" ], "variable": [ { "id": "86336a9e-a807-4a58-aa04-7c04e273a045", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt markets associated to the price" }, "response": [ { "id": "cce38a3d-7232-4961-a860-81bafdd95cae", "name": "The jwt_markets associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/jwt_markets", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "jwt_markets" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cce38a3d-7232-4961-a860-81bafdd95cae" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2fcea239-f003-4d7a-a10c-981d61a0f971" } ], "id": "6737308b-a1dd-4269-85fe-26056dad4086", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6737308b-a1dd-4269-85fe-26056dad4086" }, { "name": "jwt_stock_locations", "item": [ { "name": "Retrieve the jwt stock locations associated to the price", "id": "87f22528-9ef8-4a22-9544-46d6b9f39874", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/jwt_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "jwt_stock_locations" ], "variable": [ { "id": "c3f9b678-76e8-4919-a819-6e4c228c034b", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt stock locations associated to the price" }, "response": [ { "id": "47036545-f278-4774-b1a8-b3e9ce7c7fab", "name": "The jwt_stock_locations associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/jwt_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "jwt_stock_locations" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-47036545-f278-4774-b1a8-b3e9ce7c7fab" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-87f22528-9ef8-4a22-9544-46d6b9f39874" } ], "id": "7cc2e954-7cde-4769-b01a-51b9e2e62731", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7cc2e954-7cde-4769-b01a-51b9e2e62731" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the price", "id": "43dae5d0-952e-49e7-8536-07ee370d093b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "event_stores" ], "variable": [ { "id": "30e2d44f-7fb1-429f-97c4-e0d15c79d565", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the price" }, "response": [ { "id": "806531c2-f558-48b3-93b4-df457ac549a2", "name": "The event_stores associated to the price", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId", "event_stores" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-806531c2-f558-48b3-93b4-df457ac549a2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-43dae5d0-952e-49e7-8536-07ee370d093b" } ], "id": "a186f278-2f2f-4497-afe5-8c2de54e4a5d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a186f278-2f2f-4497-afe5-8c2de54e4a5d" }, { "name": "Retrieve a price", "id": "ce58e733-cffa-45db-9b3b-365a8441f03a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId" ], "variable": [ { "id": "1ac5ac6f-6266-4ceb-a12d-63dbd77c4400", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a price" }, "response": [ { "id": "467a3c4a-608c-493b-b953-fb1ddce45dcb", "name": "The price object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"prices\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"currency_code\": \"\",\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"original_amount_cents\": \"\",\n \"formatted_original_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"rule_outcomes\": {},\n \"processed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n },\n \"price_volume_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\"\n }\n },\n \"price_frequency_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-467a3c4a-608c-493b-b953-fb1ddce45dcb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ce58e733-cffa-45db-9b3b-365a8441f03a" }, { "name": "Update a price", "id": "62111d3d-a687-4c19-be56-a63eb9ad6366", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"processed_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId" ], "variable": [ { "id": "1e9fb052-2039-4922-88a6-574e0c7baac2", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a price" }, "response": [ { "id": "00144024-d64c-42e5-a18e-3256a445ceee", "name": "The updated price object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"processed_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId" ], "variable": [ { "key": "priceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"prices\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"currency_code\": \"\",\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"original_amount_cents\": \"\",\n \"formatted_original_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"rule_outcomes\": {},\n \"processed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n },\n \"price_volume_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\"\n }\n },\n \"price_frequency_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-00144024-d64c-42e5-a18e-3256a445ceee" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-62111d3d-a687-4c19-be56-a63eb9ad6366" }, { "name": "Delete a price", "id": "61c18a96-ff2d-4a17-9b5e-0f2c1517c930", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId" ], "variable": [ { "id": "3e6b38dd-ed48-4e9c-a869-e1529ab4e366", "key": "priceId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a price" }, "response": [ { "id": "37610b53-81cf-46b4-b1d6-dc6d221440ec", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices/:priceId", "host": [ "{{baseUrl}}" ], "path": [ "prices", ":priceId" ], "variable": [ { "key": "priceId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-37610b53-81cf-46b4-b1d6-dc6d221440ec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-61c18a96-ff2d-4a17-9b5e-0f2c1517c930" } ], "id": "191dfa6b-ca18-4bcb-90ff-c9e6a132df37", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-191dfa6b-ca18-4bcb-90ff-c9e6a132df37" }, { "name": "List all prices", "id": "86480564-afbd-443a-b1f3-a38e29d5c28d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/prices", "host": [ "{{baseUrl}}" ], "path": [ "prices" ] }, "description": "List all prices" }, "response": [ { "id": "9cc958ac-0a97-4338-ad51-f8af478d488d", "name": "A list of price objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/prices", "host": [ "{{baseUrl}}" ], "path": [ "prices" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"prices\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"currency_code\": \"\",\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"original_amount_cents\": \"\",\n \"formatted_original_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"rule_outcomes\": {},\n \"processed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n },\n \"price_volume_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\"\n }\n },\n \"price_frequency_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"prices\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"currency_code\": \"\",\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"original_amount_cents\": \"\",\n \"formatted_original_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"rule_outcomes\": {},\n \"processed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n },\n \"price_volume_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\"\n }\n },\n \"price_frequency_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9cc958ac-0a97-4338-ad51-f8af478d488d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-86480564-afbd-443a-b1f3-a38e29d5c28d" }, { "name": "Create a price", "id": "ba0d8d04-2b2c-42ff-b301-68f5ba226e69", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"prices\",\n \"attributes\": {\n \"amount_cents\": \"\",\n \"sku_code\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/prices", "host": [ "{{baseUrl}}" ], "path": [ "prices" ] }, "description": "Create a price" }, "response": [ { "id": "afea888f-a17b-4f5a-bf8c-e7bb01181fc9", "name": "The created price object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"prices\",\n \"attributes\": {\n \"amount_cents\": \"\",\n \"sku_code\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"data\": {\n \"type\": \"price_lists\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/prices", "host": [ "{{baseUrl}}" ], "path": [ "prices" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"prices\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"currency_code\": \"\",\n \"sku_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"original_amount_cents\": \"\",\n \"formatted_original_amount\": \"\",\n \"compare_at_amount_cents\": \"\",\n \"compare_at_amount_float\": \"\",\n \"formatted_compare_at_amount\": \"\",\n \"rule_outcomes\": {},\n \"processed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"rules\": {},\n \"resource_payload\": {},\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"price_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"price_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_tiers\",\n \"id\": \"\"\n }\n },\n \"price_volume_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_volume_tiers\",\n \"id\": \"\"\n }\n },\n \"price_frequency_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"price_frequency_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-afea888f-a17b-4f5a-bf8c-e7bb01181fc9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba0d8d04-2b2c-42ff-b301-68f5ba226e69" } ], "id": "c62dbbe2-290f-4f24-9793-f6c67707f7a4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c62dbbe2-290f-4f24-9793-f6c67707f7a4" }, { "name": "promotion_rules", "item": [ { "name": "{promotionRuleId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the promotion rule", "id": "10a5cfc9-1c32-427c-b255-c37a9cdecd47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotion_rules/:promotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "promotion_rules", ":promotionRuleId", "event_stores" ], "variable": [ { "id": "eec3a711-daf6-4b87-8a7e-21cef844d18b", "key": "promotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the promotion rule" }, "response": [ { "id": "95fc4817-79c6-4151-94ca-1eba52873bcf", "name": "The event_stores associated to the promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotion_rules/:promotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "promotion_rules", ":promotionRuleId", "event_stores" ], "variable": [ { "key": "promotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-95fc4817-79c6-4151-94ca-1eba52873bcf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-10a5cfc9-1c32-427c-b255-c37a9cdecd47" } ], "id": "3aa590ac-1614-44da-8682-71838e5d2e5c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3aa590ac-1614-44da-8682-71838e5d2e5c" }, { "name": "Retrieve a promotion rule", "id": "2e2a2c84-188b-4096-a87e-81f475775c29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/promotion_rules/:promotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "promotion_rules", ":promotionRuleId" ], "variable": [ { "id": "2e986a89-f07d-4172-a137-20f596f3fef7", "key": "promotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a promotion rule" }, "response": [ { "id": "a8868fad-cf62-4646-91e6-bc3fcddf5b94", "name": "The promotion rule object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotion_rules/:promotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "promotion_rules", ":promotionRuleId" ], "variable": [ { "key": "promotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a8868fad-cf62-4646-91e6-bc3fcddf5b94" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e2a2c84-188b-4096-a87e-81f475775c29" } ], "id": "40f57deb-ce7b-4f54-a5b9-dab39b47b342", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-40f57deb-ce7b-4f54-a5b9-dab39b47b342" }, { "name": "List all promotion rules", "id": "917d45e3-5558-4b3f-a546-0a80634e4471", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "promotion_rules" ] }, "description": "List all promotion rules" }, "response": [ { "id": "134ba170-a990-4274-a5f0-a11b027647a3", "name": "A list of promotion rule objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "promotion_rules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"custom_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-134ba170-a990-4274-a5f0-a11b027647a3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-917d45e3-5558-4b3f-a546-0a80634e4471" } ], "id": "d8e38167-0c78-4c4d-ba43-d0c16fb6ee2a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d8e38167-0c78-4c4d-ba43-d0c16fb6ee2a" }, { "name": "promotions", "item": [ { "name": "{promotionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the promotion", "id": "ab26f21b-874a-4aaa-9920-b2d2b20c7a11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "market" ], "variable": [ { "id": "90a35a9a-adba-4613-88b6-913b0b56ad6d", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the promotion" }, "response": [ { "id": "939f1517-a13c-42b0-890e-c86616d9e68b", "name": "The market associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/market", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "market" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-939f1517-a13c-42b0-890e-c86616d9e68b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ab26f21b-874a-4aaa-9920-b2d2b20c7a11" } ], "id": "fb9eb572-6b75-4b6a-98ec-d0a9d3e1cbaa", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fb9eb572-6b75-4b6a-98ec-d0a9d3e1cbaa" }, { "name": "order_amount_promotion_rule", "item": [ { "name": "Retrieve the order amount promotion rule associated to the promotion", "id": "d876da5d-80e6-4839-92a5-3b99710130c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "order_amount_promotion_rule" ], "variable": [ { "id": "b67e7d79-9117-4646-af08-550cb0f0f684", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order amount promotion rule associated to the promotion" }, "response": [ { "id": "61b7f021-9d01-4a3e-937b-da908f3f3b0d", "name": "The order_amount_promotion_rule associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/order_amount_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "order_amount_promotion_rule" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-61b7f021-9d01-4a3e-937b-da908f3f3b0d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d876da5d-80e6-4839-92a5-3b99710130c8" } ], "id": "d0c7b436-bc9c-49a3-9e43-01592ce08feb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d0c7b436-bc9c-49a3-9e43-01592ce08feb" }, { "name": "sku_list_promotion_rule", "item": [ { "name": "Retrieve the sku list promotion rule associated to the promotion", "id": "0b7f134d-893f-450c-9591-c1adc31b2cde", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "sku_list_promotion_rule" ], "variable": [ { "id": "c3a15ddb-07b9-41dc-abfc-7e898b91cb03", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list promotion rule associated to the promotion" }, "response": [ { "id": "79ba3684-493b-4614-80a5-7797171eb6df", "name": "The sku_list_promotion_rule associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/sku_list_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "sku_list_promotion_rule" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-79ba3684-493b-4614-80a5-7797171eb6df" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0b7f134d-893f-450c-9591-c1adc31b2cde" } ], "id": "8c28e9e6-4d7e-4b6c-a3a3-77641f8a19ea", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8c28e9e6-4d7e-4b6c-a3a3-77641f8a19ea" }, { "name": "coupon_codes_promotion_rule", "item": [ { "name": "Retrieve the coupon codes promotion rule associated to the promotion", "id": "5512389c-0061-4d18-8f1f-689b27189a22", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "coupon_codes_promotion_rule" ], "variable": [ { "id": "ef4d3b90-5aa2-4c05-b039-2292b53ee5a7", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupon codes promotion rule associated to the promotion" }, "response": [ { "id": "ba8cb8a9-cf2c-4e77-b80d-b304446fb8c2", "name": "The coupon_codes_promotion_rule associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/coupon_codes_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "coupon_codes_promotion_rule" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ba8cb8a9-cf2c-4e77-b80d-b304446fb8c2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5512389c-0061-4d18-8f1f-689b27189a22" } ], "id": "50fc2c40-fdba-4a97-ae7d-98219a9cc89f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-50fc2c40-fdba-4a97-ae7d-98219a9cc89f" }, { "name": "custom_promotion_rule", "item": [ { "name": "Retrieve the custom promotion rule associated to the promotion", "id": "1f7e5444-3cc2-4d9c-bfec-b5eec15ae410", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "custom_promotion_rule" ], "variable": [ { "id": "83fa1542-f4ec-4bf9-b096-68aed28b2448", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the custom promotion rule associated to the promotion" }, "response": [ { "id": "31795431-5ac5-4c71-ba29-734180f08632", "name": "The custom_promotion_rule associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/custom_promotion_rule", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "custom_promotion_rule" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-31795431-5ac5-4c71-ba29-734180f08632" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1f7e5444-3cc2-4d9c-bfec-b5eec15ae410" } ], "id": "a17dbf01-66c7-44b8-a268-82a9501afb12", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a17dbf01-66c7-44b8-a268-82a9501afb12" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the promotion", "id": "beedef74-c514-42c0-b0ef-9a2030d65c47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "sku_list" ], "variable": [ { "id": "d425d4e1-ecd0-4ea8-ba44-5611d5f29587", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the promotion" }, "response": [ { "id": "0aac9675-974a-48ad-a565-e53b4769a601", "name": "The sku_list associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "sku_list" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0aac9675-974a-48ad-a565-e53b4769a601" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-beedef74-c514-42c0-b0ef-9a2030d65c47" } ], "id": "41518f5f-c3d7-475f-bd26-e8302c14a053", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-41518f5f-c3d7-475f-bd26-e8302c14a053" }, { "name": "coupons", "item": [ { "name": "Retrieve the coupons associated to the promotion", "id": "5d128074-969c-45f4-8e9e-58b1bec64019", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "coupons" ], "variable": [ { "id": "490a8d1c-5037-479b-b758-3f38e902e565", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the coupons associated to the promotion" }, "response": [ { "id": "f4132e10-6759-4b5a-b54e-bb18d257f47e", "name": "The coupons associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/coupons", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "coupons" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f4132e10-6759-4b5a-b54e-bb18d257f47e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5d128074-969c-45f4-8e9e-58b1bec64019" } ], "id": "b1de53cc-adb4-4f65-89f2-b54d5b4f8468", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b1de53cc-adb4-4f65-89f2-b54d5b4f8468" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the promotion", "id": "c924a512-a53d-47a3-839e-2435047adcc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "attachments" ], "variable": [ { "id": "a0b32378-51fc-4aac-87cc-04dd39691be6", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the promotion" }, "response": [ { "id": "5e8bf1c6-256d-4c7f-90eb-93649263c6b7", "name": "The attachments associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "attachments" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5e8bf1c6-256d-4c7f-90eb-93649263c6b7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c924a512-a53d-47a3-839e-2435047adcc4" } ], "id": "ade62288-15a2-4b0f-a3d8-2342a89d6111", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ade62288-15a2-4b0f-a3d8-2342a89d6111" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the promotion", "id": "76a98810-f181-462b-ac9b-50ca835ce1c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "events" ], "variable": [ { "id": "7803cd21-0292-4512-84e2-087d6d4e03a6", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the promotion" }, "response": [ { "id": "46952a84-914e-4792-8992-80fb53526166", "name": "The events associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/events", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "events" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-46952a84-914e-4792-8992-80fb53526166" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-76a98810-f181-462b-ac9b-50ca835ce1c9" } ], "id": "4fb6f0e9-53c4-4fa9-a72a-d88366b4ec6e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4fb6f0e9-53c4-4fa9-a72a-d88366b4ec6e" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the promotion", "id": "67609c2e-c553-4a69-97b1-732a7ddb9fa9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "tags" ], "variable": [ { "id": "8ac4fae2-289c-4168-98d6-3dd9f36d343e", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the promotion" }, "response": [ { "id": "4029e311-30b2-41b2-917b-dec77aa16337", "name": "The tags associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "tags" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4029e311-30b2-41b2-917b-dec77aa16337" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-67609c2e-c553-4a69-97b1-732a7ddb9fa9" } ], "id": "e752dc18-abd9-4b75-ba3d-90e78751c882", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e752dc18-abd9-4b75-ba3d-90e78751c882" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the promotion", "id": "4950ed8d-16ef-4383-b3ad-5318773c65d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "event_stores" ], "variable": [ { "id": "961284c7-0e9f-45b5-ada8-4b0c0b313723", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the promotion" }, "response": [ { "id": "12ed7a5d-d682-4715-8409-9727fc43ce9a", "name": "The event_stores associated to the promotion", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId", "event_stores" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-12ed7a5d-d682-4715-8409-9727fc43ce9a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4950ed8d-16ef-4383-b3ad-5318773c65d5" } ], "id": "cfc1f842-91b4-4591-bd77-04706e261fcc", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cfc1f842-91b4-4591-bd77-04706e261fcc" }, { "name": "Retrieve a promotion", "id": "ad3dddb9-c152-4047-9605-17e663957379", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId" ], "variable": [ { "id": "a660e3aa-66c5-4e99-ae4f-475a5890a1ab", "key": "promotionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a promotion" }, "response": [ { "id": "6897302b-891f-42f3-8fc8-7faac1fe0799", "name": "The promotion object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions/:promotionId", "host": [ "{{baseUrl}}" ], "path": [ "promotions", ":promotionId" ], "variable": [ { "key": "promotionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_amount_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6897302b-891f-42f3-8fc8-7faac1fe0799" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad3dddb9-c152-4047-9605-17e663957379" } ], "id": "89e462be-54fa-41c9-be93-1ec408fd82d3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-89e462be-54fa-41c9-be93-1ec408fd82d3" }, { "name": "List all promotions", "id": "56fd897c-bf0f-455a-99a2-b420e49062c6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/promotions", "host": [ "{{baseUrl}}" ], "path": [ "promotions" ] }, "description": "List all promotions" }, "response": [ { "id": "2844a57d-d63e-4b82-ac13-07b88a8a6a53", "name": "A list of promotion objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/promotions", "host": [ "{{baseUrl}}" ], "path": [ "promotions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"flex_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"promotions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"free_shipping_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_amount_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupon_codes_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"custom_promotion_rule\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2844a57d-d63e-4b82-ac13-07b88a8a6a53" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-56fd897c-bf0f-455a-99a2-b420e49062c6" } ], "id": "7dd0eb42-8c98-4e3c-b8a5-e6a63a347b70", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7dd0eb42-8c98-4e3c-b8a5-e6a63a347b70" }, { "name": "recurring_order_copies", "item": [ { "name": "{recurringOrderCopyId}", "item": [ { "name": "source_order", "item": [ { "name": "Retrieve the source order associated to the recurring order copy", "id": "ff943794-9ba6-460a-bdbd-d4d172d59751", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "source_order" ], "variable": [ { "id": "d6d7c415-42b7-4276-8f8d-9440e421c5e2", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the source order associated to the recurring order copy" }, "response": [ { "id": "c143ffb9-0f0b-4b20-bd6e-dbfafe5ab2d7", "name": "The source_order associated to the recurring order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/source_order", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "source_order" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c143ffb9-0f0b-4b20-bd6e-dbfafe5ab2d7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ff943794-9ba6-460a-bdbd-d4d172d59751" } ], "id": "3bfeebb2-6860-42a8-a73d-e9cc91849bda", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3bfeebb2-6860-42a8-a73d-e9cc91849bda" }, { "name": "target_order", "item": [ { "name": "Retrieve the target order associated to the recurring order copy", "id": "dd197c0c-b145-4cb9-aa63-9283709381ab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/target_order", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "target_order" ], "variable": [ { "id": "380f683c-91b2-4dc8-a3ce-95d0e488c869", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the target order associated to the recurring order copy" }, "response": [ { "id": "f0cce5e2-3dd4-4382-be6c-63178a49a2af", "name": "The target_order associated to the recurring order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/target_order", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "target_order" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f0cce5e2-3dd4-4382-be6c-63178a49a2af" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dd197c0c-b145-4cb9-aa63-9283709381ab" } ], "id": "1a509f0f-559c-444d-b8fe-955a0b57ea7f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1a509f0f-559c-444d-b8fe-955a0b57ea7f" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the recurring order copy", "id": "cc21133c-75cb-4a7f-af16-e2f85efce5e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/events", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "events" ], "variable": [ { "id": "e9400bf7-53f3-466c-b05c-0cc7170af777", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the recurring order copy" }, "response": [ { "id": "1d7dde4f-4d64-4fd4-8756-be57bb6e6eb2", "name": "The events associated to the recurring order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/events", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "events" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1d7dde4f-4d64-4fd4-8756-be57bb6e6eb2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cc21133c-75cb-4a7f-af16-e2f85efce5e5" } ], "id": "fcb70236-52a4-422d-9bec-823200ccde60", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fcb70236-52a4-422d-9bec-823200ccde60" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the recurring order copy", "id": "a410a5ff-7d8c-4370-b5ab-978cdaf0e3d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "event_stores" ], "variable": [ { "id": "cdadd498-c644-4303-984f-cdeace2aed5a", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the recurring order copy" }, "response": [ { "id": "d5b1b537-949c-4f48-8233-7999edd86bdc", "name": "The event_stores associated to the recurring order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "event_stores" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d5b1b537-949c-4f48-8233-7999edd86bdc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a410a5ff-7d8c-4370-b5ab-978cdaf0e3d6" } ], "id": "299b0fcf-1d32-4dfc-bc6e-0c6d35f07531", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-299b0fcf-1d32-4dfc-bc6e-0c6d35f07531" }, { "name": "order_subscription", "item": [ { "name": "Retrieve the order subscription associated to the recurring order copy", "id": "aaa19919-1ee0-4fde-8925-30d0d7c8accf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "order_subscription" ], "variable": [ { "id": "fae09576-b4c5-4f20-ab79-926346996f1b", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscription associated to the recurring order copy" }, "response": [ { "id": "1221e74b-6008-4b2e-999a-f66fa4f05565", "name": "The order_subscription associated to the recurring order copy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId/order_subscription", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId", "order_subscription" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1221e74b-6008-4b2e-999a-f66fa4f05565" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-aaa19919-1ee0-4fde-8925-30d0d7c8accf" } ], "id": "880d0c66-249b-49a0-84bf-fc3f27ea16a0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-880d0c66-249b-49a0-84bf-fc3f27ea16a0" }, { "name": "Retrieve a recurring order copy", "id": "035b1f8e-b00e-4473-a633-815838127be9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId" ], "variable": [ { "id": "c2245b55-ebd1-494f-9f01-42333b43db20", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a recurring order copy" }, "response": [ { "id": "a37f3fca-5bbf-40e0-a78d-e24383bc211d", "name": "The recurring order copy object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"recurring_order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"recurring_order_copies\",\n \"status\": \"in_progress\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a37f3fca-5bbf-40e0-a78d-e24383bc211d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-035b1f8e-b00e-4473-a633-815838127be9" }, { "name": "Update a recurring order copy", "id": "dcfa6a62-659e-44b6-a42d-2fb25fadd35a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId" ], "variable": [ { "id": "c9f68ece-1294-43a1-b9f1-522754ab5537", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a recurring order copy" }, "response": [ { "id": "dbf9287b-e333-4881-a87c-7723956562b1", "name": "The updated recurring order copy object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"recurring_order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"recurring_order_copies\",\n \"status\": \"in_progress\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dbf9287b-e333-4881-a87c-7723956562b1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dcfa6a62-659e-44b6-a42d-2fb25fadd35a" }, { "name": "Delete a recurring order copy", "id": "f2f1ccb2-4225-4b3a-ad4c-dff94fc3a3cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId" ], "variable": [ { "id": "2c5441e3-552a-497a-ab23-6d2663f68f77", "key": "recurringOrderCopyId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a recurring order copy" }, "response": [ { "id": "1478ec1a-c9a6-4634-8ef8-7d1613d02b35", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies/:recurringOrderCopyId", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies", ":recurringOrderCopyId" ], "variable": [ { "key": "recurringOrderCopyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1478ec1a-c9a6-4634-8ef8-7d1613d02b35" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f2f1ccb2-4225-4b3a-ad4c-dff94fc3a3cc" } ], "id": "c2a3f27e-2c6a-4db8-b642-6b92ca87a348", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c2a3f27e-2c6a-4db8-b642-6b92ca87a348" }, { "name": "List all recurring order copies", "id": "fb74b62b-2364-46f2-8be1-e119d94952c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies" ] }, "description": "List all recurring order copies" }, "response": [ { "id": "b42738d1-603d-4ad0-a1c1-f067554778e9", "name": "A list of recurring order copy objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"recurring_order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"completed\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"recurring_order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_copies\",\n \"status\": \"in_progress\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b42738d1-603d-4ad0-a1c1-f067554778e9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb74b62b-2364-46f2-8be1-e119d94952c7" }, { "name": "Create a recurring order copy", "id": "5d9f6ab4-5386-47b7-9b4f-95a6e8c6622f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"attributes\": {\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies" ] }, "description": "Create a recurring order copy" }, "response": [ { "id": "e2719be0-7604-4267-b82c-b6826a3d18e1", "name": "The created recurring order copy object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"recurring_order_copies\",\n \"attributes\": {\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/recurring_order_copies", "host": [ "{{baseUrl}}" ], "path": [ "recurring_order_copies" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"recurring_order_copies\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"recurring_order_copies\",\n \"status\": \"in_progress\",\n \"started_at\": \"\",\n \"completed_at\": \"\",\n \"failed_at\": \"\",\n \"errors_log\": {},\n \"errors_count\": \"\",\n \"place_target_order\": \"\",\n \"reuse_wallet\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"source_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"source_order\",\n \"id\": \"\"\n }\n },\n \"target_order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"target_order\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"order_subscription\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscription\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e2719be0-7604-4267-b82c-b6826a3d18e1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5d9f6ab4-5386-47b7-9b4f-95a6e8c6622f" } ], "id": "079e73a0-dba1-4be7-9a1a-47587be8f51c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-079e73a0-dba1-4be7-9a1a-47587be8f51c" }, { "name": "refunds", "item": [ { "name": "{refundId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the refund", "id": "0d679e02-7529-49be-a600-343ceffa61fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/refunds/:refundId/order", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "order" ], "variable": [ { "id": "bf6e4b8f-97d8-4d6a-b393-4d16acb2dae7", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the refund" }, "response": [ { "id": "dac15353-ef59-4c9a-81bb-8e3e32e649ee", "name": "The order associated to the refund", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId/order", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "order" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dac15353-ef59-4c9a-81bb-8e3e32e649ee" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0d679e02-7529-49be-a600-343ceffa61fb" } ], "id": "80dd488b-209a-4d9e-bce5-32733860ef2c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-80dd488b-209a-4d9e-bce5-32733860ef2c" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the refund", "id": "68071d5a-2406-4803-a130-f5b27e8f5972", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/refunds/:refundId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "attachments" ], "variable": [ { "id": "8dc25aae-7697-4504-ba02-65eb79480712", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the refund" }, "response": [ { "id": "e3689ac1-f1e2-48fa-a4c4-8aa94dea2fa0", "name": "The attachments associated to the refund", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "attachments" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3689ac1-f1e2-48fa-a4c4-8aa94dea2fa0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-68071d5a-2406-4803-a130-f5b27e8f5972" } ], "id": "f03f4430-6c28-4aa6-b752-a6a869bfac51", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f03f4430-6c28-4aa6-b752-a6a869bfac51" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the refund", "id": "42f2f8db-35c9-42f1-9f8e-4bf9048f5e88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/refunds/:refundId/events", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "events" ], "variable": [ { "id": "3434d2d2-1cec-46cb-a1de-0971f14a10f5", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the refund" }, "response": [ { "id": "4b2263b8-a77c-435b-b499-15148bcaf53a", "name": "The events associated to the refund", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId/events", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "events" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4b2263b8-a77c-435b-b499-15148bcaf53a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-42f2f8db-35c9-42f1-9f8e-4bf9048f5e88" } ], "id": "db327182-e950-49cb-9dee-119149414512", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-db327182-e950-49cb-9dee-119149414512" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the refund", "id": "8821b8bb-f157-422a-bbe2-f9f5abfc7f11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/refunds/:refundId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "event_stores" ], "variable": [ { "id": "9f116d0e-214d-4322-8acb-0b2969e31071", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the refund" }, "response": [ { "id": "8e998117-86f0-4f98-8702-eaefe28baf2c", "name": "The event_stores associated to the refund", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "event_stores" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8e998117-86f0-4f98-8702-eaefe28baf2c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8821b8bb-f157-422a-bbe2-f9f5abfc7f11" } ], "id": "8e84d349-cb95-430f-9916-bd722951e2ed", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8e84d349-cb95-430f-9916-bd722951e2ed" }, { "name": "reference_capture", "item": [ { "name": "Retrieve the reference capture associated to the refund", "id": "8942156a-1c32-42fd-a171-4e7661d4e2a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/refunds/:refundId/reference_capture", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "reference_capture" ], "variable": [ { "id": "c9aa6ac8-e9a9-41ec-a9e2-6ede85645f88", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reference capture associated to the refund" }, "response": [ { "id": "bd8f686c-6ea3-4fe3-8e73-6464c4b6d1d1", "name": "The reference_capture associated to the refund", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId/reference_capture", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "reference_capture" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bd8f686c-6ea3-4fe3-8e73-6464c4b6d1d1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8942156a-1c32-42fd-a171-4e7661d4e2a7" } ], "id": "6cf669c1-3529-4072-95ac-0cd3dc023d65", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6cf669c1-3529-4072-95ac-0cd3dc023d65" }, { "name": "return", "item": [ { "name": "Retrieve the return associated to the refund", "id": "c1bd2434-619d-4a1d-8cbf-ac14cac639e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/refunds/:refundId/return", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "return" ], "variable": [ { "id": "2712cd3c-c47a-4b61-8c39-9eb3c3cf4d1c", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the return associated to the refund" }, "response": [ { "id": "30525772-ae44-43d6-85b9-2a2290972bed", "name": "The return associated to the refund", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId/return", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId", "return" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-30525772-ae44-43d6-85b9-2a2290972bed" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c1bd2434-619d-4a1d-8cbf-ac14cac639e1" } ], "id": "b130de6d-b7df-49d4-8b12-6496a5148eb0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b130de6d-b7df-49d4-8b12-6496a5148eb0" }, { "name": "Retrieve a refund", "id": "d99717c5-0f41-4689-a728-f64c116858a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId" ], "variable": [ { "id": "35d2eaf6-f77f-4022-a16b-7285fd176ff5", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a refund" }, "response": [ { "id": "62a2f5bc-912e-438c-a4c1-0d01b55bada9", "name": "The refund object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"refunds\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-62a2f5bc-912e-438c-a4c1-0d01b55bada9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d99717c5-0f41-4689-a728-f64c116858a8" }, { "name": "Update a refund", "id": "60ce6f38-dbce-4210-9e73-75d65771a24f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId" ], "variable": [ { "id": "6eb94d0f-ab1f-4ec3-9786-a849d07f1551", "key": "refundId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a refund" }, "response": [ { "id": "81595ffe-8a7a-4836-9d9f-fce57b264aee", "name": "The updated refund object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"refunds\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/:refundId", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refundId" ], "variable": [ { "key": "refundId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"refunds\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-81595ffe-8a7a-4836-9d9f-fce57b264aee" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-60ce6f38-dbce-4210-9e73-75d65771a24f" } ], "id": "c4fe83d9-5ee9-4fe2-9098-86c8662de96c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c4fe83d9-5ee9-4fe2-9098-86c8662de96c" }, { "name": "List all refunds", "id": "5c7d3c62-fc8d-4832-a93b-54bf1b68318f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] }, "description": "List all refunds" }, "response": [ { "id": "3d50c004-cc04-49fb-a7f4-3931aaa34daf", "name": "A list of refund objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"refunds\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"refunds\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"voids\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d50c004-cc04-49fb-a7f4-3931aaa34daf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5c7d3c62-fc8d-4832-a93b-54bf1b68318f" } ], "id": "36755c1b-b66c-46ed-be31-c06bfca2d566", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-36755c1b-b66c-46ed-be31-c06bfca2d566" }, { "name": "reserved_stocks", "item": [ { "name": "{reservedStockId}", "item": [ { "name": "stock_item", "item": [ { "name": "Retrieve the stock item associated to the reserved stock", "id": "3de04700-cf28-4e29-a9b6-4465d33b14b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/stock_item", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "stock_item" ], "variable": [ { "id": "e2516010-482d-4e94-8f03-9a42e238ccc9", "key": "reservedStockId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock item associated to the reserved stock" }, "response": [ { "id": "bbe37ceb-4a07-42cb-b00b-5069fc89de06", "name": "The stock_item associated to the reserved stock", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/stock_item", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "stock_item" ], "variable": [ { "key": "reservedStockId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bbe37ceb-4a07-42cb-b00b-5069fc89de06" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3de04700-cf28-4e29-a9b6-4465d33b14b8" } ], "id": "2c9a9d22-f0da-46f5-9973-57a28ea2d2a5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2c9a9d22-f0da-46f5-9973-57a28ea2d2a5" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the reserved stock", "id": "8396bce1-4cdb-4f31-ac3e-59fc18afb85f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/sku", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "sku" ], "variable": [ { "id": "6db7a3ca-b0f6-4a8f-b720-cec10ca95965", "key": "reservedStockId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the reserved stock" }, "response": [ { "id": "b2db52ab-6ebf-4f0a-9d53-7e427a87a95a", "name": "The sku associated to the reserved stock", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/sku", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "sku" ], "variable": [ { "key": "reservedStockId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b2db52ab-6ebf-4f0a-9d53-7e427a87a95a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8396bce1-4cdb-4f31-ac3e-59fc18afb85f" } ], "id": "44983dd2-4366-4098-883e-abcc5abb92ac", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-44983dd2-4366-4098-883e-abcc5abb92ac" }, { "name": "stock_reservations", "item": [ { "name": "Retrieve the stock reservations associated to the reserved stock", "id": "b1a2ae74-43d5-483b-8195-46a803f56f31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "stock_reservations" ], "variable": [ { "id": "d564614f-d477-47de-9f28-147e6a1c377e", "key": "reservedStockId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservations associated to the reserved stock" }, "response": [ { "id": "84eb6259-7f9f-47cf-8cc2-941b0d0be6ff", "name": "The stock_reservations associated to the reserved stock", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "stock_reservations" ], "variable": [ { "key": "reservedStockId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-84eb6259-7f9f-47cf-8cc2-941b0d0be6ff" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b1a2ae74-43d5-483b-8195-46a803f56f31" } ], "id": "210276b1-fbb4-4c22-aa8d-550da19eee30", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-210276b1-fbb4-4c22-aa8d-550da19eee30" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the reserved stock", "id": "43107e44-e2e0-4957-9485-74769add088e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "event_stores" ], "variable": [ { "id": "9fd02a62-5ae1-421a-a984-d71890d893bd", "key": "reservedStockId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the reserved stock" }, "response": [ { "id": "5a346e35-8484-457b-9b0e-0fde9ffdd109", "name": "The event_stores associated to the reserved stock", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId", "event_stores" ], "variable": [ { "key": "reservedStockId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5a346e35-8484-457b-9b0e-0fde9ffdd109" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-43107e44-e2e0-4957-9485-74769add088e" } ], "id": "78a46e13-d5bf-4066-8ff7-5eab97218ade", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-78a46e13-d5bf-4066-8ff7-5eab97218ade" }, { "name": "Retrieve a reserved stock", "id": "ee9c227a-f3ae-4b35-ba73-effa93b7eb12", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId" ], "variable": [ { "id": "ea61b56e-4c4b-467e-aa3e-c23c9d6e3411", "key": "reservedStockId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a reserved stock" }, "response": [ { "id": "98399a6c-7c4c-4f98-8a3e-5f1ac51eb0d8", "name": "The reserved stock object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/reserved_stocks/:reservedStockId", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks", ":reservedStockId" ], "variable": [ { "key": "reservedStockId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"reserved_stocks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-98399a6c-7c4c-4f98-8a3e-5f1ac51eb0d8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ee9c227a-f3ae-4b35-ba73-effa93b7eb12" } ], "id": "7284299d-44ca-441f-b9c5-a9ea1a16a760", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7284299d-44ca-441f-b9c5-a9ea1a16a760" }, { "name": "List all reserved stocks", "id": "5fa7195a-6331-421b-a9d6-04a195e16666", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/reserved_stocks", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks" ] }, "description": "List all reserved stocks" }, "response": [ { "id": "b42ea84f-5943-4a7b-a0f9-f36d529220c7", "name": "A list of reserved stock objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/reserved_stocks", "host": [ "{{baseUrl}}" ], "path": [ "reserved_stocks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"reserved_stocks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"reserved_stocks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b42ea84f-5943-4a7b-a0f9-f36d529220c7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5fa7195a-6331-421b-a9d6-04a195e16666" } ], "id": "8b285793-fa6f-4de5-86c2-742e5f0d173a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8b285793-fa6f-4de5-86c2-742e5f0d173a" }, { "name": "resource_errors", "item": [ { "name": "{resourceErrorId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the resource error", "id": "0e47a0ee-cfdc-4635-a0a2-cdb63119fbff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/resource_errors/:resourceErrorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "resource_errors", ":resourceErrorId", "event_stores" ], "variable": [ { "id": "e111b932-5e4d-48c3-bcf5-825712278ac1", "key": "resourceErrorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the resource error" }, "response": [ { "id": "010fa776-1e55-4a71-9657-2bab40ebe455", "name": "The event_stores associated to the resource error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/resource_errors/:resourceErrorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "resource_errors", ":resourceErrorId", "event_stores" ], "variable": [ { "key": "resourceErrorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-010fa776-1e55-4a71-9657-2bab40ebe455" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0e47a0ee-cfdc-4635-a0a2-cdb63119fbff" } ], "id": "30f344dd-b8a3-4c7d-bd4c-a5146f50deac", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-30f344dd-b8a3-4c7d-bd4c-a5146f50deac" }, { "name": "Retrieve a resource error", "id": "df6dd742-ecbf-4425-a72c-5127809ece6b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/resource_errors/:resourceErrorId", "host": [ "{{baseUrl}}" ], "path": [ "resource_errors", ":resourceErrorId" ], "variable": [ { "id": "dc982520-a3a4-456b-8fde-db228f6f1a6b", "key": "resourceErrorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a resource error" }, "response": [ { "id": "9ea281e2-59c2-4c0b-82d7-0f395d8bfd1f", "name": "The resource error object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/resource_errors/:resourceErrorId", "host": [ "{{baseUrl}}" ], "path": [ "resource_errors", ":resourceErrorId" ], "variable": [ { "key": "resourceErrorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"resource_errors\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"resource\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9ea281e2-59c2-4c0b-82d7-0f395d8bfd1f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-df6dd742-ecbf-4425-a72c-5127809ece6b" } ], "id": "e44a0222-0af5-4968-83ff-3a2d406c0902", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e44a0222-0af5-4968-83ff-3a2d406c0902" }, { "name": "List all resource errors", "id": "ed83e0f3-2149-4184-82c2-d1a1523cedc5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/resource_errors", "host": [ "{{baseUrl}}" ], "path": [ "resource_errors" ] }, "description": "List all resource errors" }, "response": [ { "id": "d54e6fcb-27f8-40fa-912c-ede322043caa", "name": "A list of resource error objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/resource_errors", "host": [ "{{baseUrl}}" ], "path": [ "resource_errors" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"resource_errors\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"resource\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"resource_errors\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"resource\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d54e6fcb-27f8-40fa-912c-ede322043caa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ed83e0f3-2149-4184-82c2-d1a1523cedc5" } ], "id": "c6815cbc-76da-4f78-b81e-4e72ffe88e07", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c6815cbc-76da-4f78-b81e-4e72ffe88e07" }, { "name": "return_line_items", "item": [ { "name": "{returnLineItemId}", "item": [ { "name": "return", "item": [ { "name": "Retrieve the return associated to the return line item", "id": "4356b8a4-c909-41d9-8b40-ec31d61a120f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId/return", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId", "return" ], "variable": [ { "id": "7ade9e8c-05b2-4680-b3bd-f035ad3e608c", "key": "returnLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the return associated to the return line item" }, "response": [ { "id": "5050a33f-be7d-4e2e-930d-ff6a0b05febf", "name": "The return associated to the return line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId/return", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId", "return" ], "variable": [ { "key": "returnLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5050a33f-be7d-4e2e-930d-ff6a0b05febf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4356b8a4-c909-41d9-8b40-ec31d61a120f" } ], "id": "068aeac6-810a-43bb-b866-d28f25fb6c4d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-068aeac6-810a-43bb-b866-d28f25fb6c4d" }, { "name": "line_item", "item": [ { "name": "Retrieve the line item associated to the return line item", "id": "ea643b9a-de8c-4148-87d7-b959fcbb6995", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId", "line_item" ], "variable": [ { "id": "9b9886ca-ce0f-4010-bb3c-75ac5f752a48", "key": "returnLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item associated to the return line item" }, "response": [ { "id": "66c18f58-ee4d-4b6c-b16f-7fdfc09bac0e", "name": "The line_item associated to the return line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId", "line_item" ], "variable": [ { "key": "returnLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-66c18f58-ee4d-4b6c-b16f-7fdfc09bac0e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ea643b9a-de8c-4148-87d7-b959fcbb6995" } ], "id": "c37994e9-cbe9-42e1-9752-ebd633edf49f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c37994e9-cbe9-42e1-9752-ebd633edf49f" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the return line item", "id": "c00134a4-2c7d-4b82-b74e-3d19361e671f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId", "event_stores" ], "variable": [ { "id": "ba498c5f-f0c7-404c-a685-2c6cdc72ed9b", "key": "returnLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the return line item" }, "response": [ { "id": "08114122-75a2-4e57-ad38-72e63594dcdc", "name": "The event_stores associated to the return line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId", "event_stores" ], "variable": [ { "key": "returnLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-08114122-75a2-4e57-ad38-72e63594dcdc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c00134a4-2c7d-4b82-b74e-3d19361e671f" } ], "id": "94fc440c-5fdf-4b78-aafb-f89a00bcc9e0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-94fc440c-5fdf-4b78-aafb-f89a00bcc9e0" }, { "name": "Retrieve a return line item", "id": "7ad873c4-263c-4a90-bde4-9e706a9d69af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId" ], "variable": [ { "id": "fce392ca-b7a5-4296-ae88-2ca06307b190", "key": "returnLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a return line item" }, "response": [ { "id": "cd796d48-a015-4639-ad83-4d00a31fdcc0", "name": "The return line item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId" ], "variable": [ { "key": "returnLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"return_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"return_reason\": {},\n \"restocked_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd796d48-a015-4639-ad83-4d00a31fdcc0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7ad873c4-263c-4a90-bde4-9e706a9d69af" }, { "name": "Update a return line item", "id": "e3037374-42ac-44fe-970a-d8df61aa64d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"quantity\": \"\",\n \"_restock\": \"\",\n \"return_reason\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId" ], "variable": [ { "id": "9ff388d7-e573-4111-9eff-815d2eb14d05", "key": "returnLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a return line item" }, "response": [ { "id": "7ef84121-ac6a-4b0f-b5b5-7bc1982f743a", "name": "The updated return line item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"quantity\": \"\",\n \"_restock\": \"\",\n \"return_reason\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId" ], "variable": [ { "key": "returnLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"return_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"return_reason\": {},\n \"restocked_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7ef84121-ac6a-4b0f-b5b5-7bc1982f743a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e3037374-42ac-44fe-970a-d8df61aa64d5" }, { "name": "Delete a return line item", "id": "da2c58fb-6728-4644-af82-f8f522e1711a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId" ], "variable": [ { "id": "4f0c876c-2767-462c-94f2-75c79624ca4f", "key": "returnLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a return line item" }, "response": [ { "id": "5af6ccf6-b6a6-4f0d-8434-510896ae6a06", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/return_line_items/:returnLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items", ":returnLineItemId" ], "variable": [ { "key": "returnLineItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5af6ccf6-b6a6-4f0d-8434-510896ae6a06" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-da2c58fb-6728-4644-af82-f8f522e1711a" } ], "id": "e7c74a26-d00f-41fe-b66e-dfa884a4fc05", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e7c74a26-d00f-41fe-b66e-dfa884a4fc05" }, { "name": "List all return line items", "id": "4e5ca039-8ca2-4aab-8779-9a06caecfff8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items" ] }, "description": "List all return line items" }, "response": [ { "id": "32ba9d72-38a1-434c-b6a9-7908a5d72e8d", "name": "A list of return line item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"return_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"return_reason\": {},\n \"restocked_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"return_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"return_reason\": {},\n \"restocked_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-32ba9d72-38a1-434c-b6a9-7908a5d72e8d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4e5ca039-8ca2-4aab-8779-9a06caecfff8" }, { "name": "Create a return line item", "id": "84e0305c-659f-4c12-9424-9fe2dfefac1e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"return_line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"return_reason\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items" ] }, "description": "Create a return line item" }, "response": [ { "id": "aba2ab04-14ae-4874-8b15-df7940fcce4b", "name": "The created return line item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"return_line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"return_reason\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "return_line_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"return_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"total_amount_cents\": \"\",\n \"total_amount_float\": \"\",\n \"formatted_total_amount\": \"\",\n \"return_reason\": {},\n \"restocked_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"return\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aba2ab04-14ae-4874-8b15-df7940fcce4b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-84e0305c-659f-4c12-9424-9fe2dfefac1e" } ], "id": "6a081621-3529-47e8-9cc6-5a601f67d7b4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6a081621-3529-47e8-9cc6-5a601f67d7b4" }, { "name": "returns", "item": [ { "name": "{returnId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the return", "id": "e3e2ecbd-2370-413c-8135-c13bb46a4bce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/order", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "order" ], "variable": [ { "id": "7cfcff4e-ed65-48ef-a89a-8b7ef0f7c691", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the return" }, "response": [ { "id": "802e56f6-1c36-4de9-8e4a-bafad2e6d806", "name": "The order associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/order", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "order" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-802e56f6-1c36-4de9-8e4a-bafad2e6d806" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e3e2ecbd-2370-413c-8135-c13bb46a4bce" } ], "id": "690daebb-2340-4fcc-a1c4-c09925b7b8e4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-690daebb-2340-4fcc-a1c4-c09925b7b8e4" }, { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the return", "id": "c456d7bd-d4c2-4006-8d17-4f33fff8e0e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/customer", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "customer" ], "variable": [ { "id": "a8e56f7a-9fd3-4619-9926-16fe62698c06", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the return" }, "response": [ { "id": "845bee03-b756-419e-a065-8feff78f7504", "name": "The customer associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/customer", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "customer" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-845bee03-b756-419e-a065-8feff78f7504" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c456d7bd-d4c2-4006-8d17-4f33fff8e0e4" } ], "id": "50d51e6d-dc2d-4c93-ba58-b639ce728c65", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-50d51e6d-dc2d-4c93-ba58-b639ce728c65" }, { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the return", "id": "3cd2d033-67c5-4fbf-a628-5d49ce764e87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "stock_location" ], "variable": [ { "id": "8c362aa4-590d-4345-8fd0-59df182a1af0", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the return" }, "response": [ { "id": "c20cac48-2619-4770-ba4e-6a510b5a8c33", "name": "The stock_location associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "stock_location" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c20cac48-2619-4770-ba4e-6a510b5a8c33" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3cd2d033-67c5-4fbf-a628-5d49ce764e87" } ], "id": "3ef3e721-c4c7-4026-aa15-7a46e2a5fce8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3ef3e721-c4c7-4026-aa15-7a46e2a5fce8" }, { "name": "origin_address", "item": [ { "name": "Retrieve the origin address associated to the return", "id": "0cd500f7-d72e-42a2-a5a7-617c29bdaa5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/origin_address", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "origin_address" ], "variable": [ { "id": "7be0eae6-4249-4200-84a7-ae06bf145a5c", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the origin address associated to the return" }, "response": [ { "id": "5960bcb6-4008-49d7-a307-acf06ef757a0", "name": "The origin_address associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/origin_address", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "origin_address" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5960bcb6-4008-49d7-a307-acf06ef757a0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0cd500f7-d72e-42a2-a5a7-617c29bdaa5c" } ], "id": "b14405c7-2b2f-40a6-bc74-8ae8b8e9af3c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b14405c7-2b2f-40a6-bc74-8ae8b8e9af3c" }, { "name": "destination_address", "item": [ { "name": "Retrieve the destination address associated to the return", "id": "8bf49c95-5187-461b-b952-bb523083e673", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/destination_address", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "destination_address" ], "variable": [ { "id": "5c76f498-9f97-430d-a1d6-964592ee6c07", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the destination address associated to the return" }, "response": [ { "id": "9cf90c37-703f-4d29-bbb8-45b0fe4b3de0", "name": "The destination_address associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/destination_address", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "destination_address" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9cf90c37-703f-4d29-bbb8-45b0fe4b3de0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8bf49c95-5187-461b-b952-bb523083e673" } ], "id": "653746a5-39e3-4f74-a13f-b4c1f89930fb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-653746a5-39e3-4f74-a13f-b4c1f89930fb" }, { "name": "reference_capture", "item": [ { "name": "Retrieve the reference capture associated to the return", "id": "ba2bb827-4f4d-44c3-8a11-d5b0780bc197", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/reference_capture", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "reference_capture" ], "variable": [ { "id": "f50d4c25-daa4-469c-8825-42910c78ffb7", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reference capture associated to the return" }, "response": [ { "id": "2e6407e6-331a-4f98-bd15-507f3d903261", "name": "The reference_capture associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/reference_capture", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "reference_capture" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2e6407e6-331a-4f98-bd15-507f3d903261" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ba2bb827-4f4d-44c3-8a11-d5b0780bc197" } ], "id": "b1189bb7-2c9c-4dd2-965b-d6a28fe4b75b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b1189bb7-2c9c-4dd2-965b-d6a28fe4b75b" }, { "name": "reference_refund", "item": [ { "name": "Retrieve the reference refund associated to the return", "id": "a0352621-de6e-4a6d-a6c3-45cc30afa987", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/reference_refund", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "reference_refund" ], "variable": [ { "id": "142db578-cb02-433a-bb5a-df324ee9664d", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reference refund associated to the return" }, "response": [ { "id": "9403af3a-803e-4034-8e4b-2cdd12cc1217", "name": "The reference_refund associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/reference_refund", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "reference_refund" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9403af3a-803e-4034-8e4b-2cdd12cc1217" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a0352621-de6e-4a6d-a6c3-45cc30afa987" } ], "id": "509310cd-3e00-45ea-bd8b-4908af52d5dc", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-509310cd-3e00-45ea-bd8b-4908af52d5dc" }, { "name": "return_line_items", "item": [ { "name": "Retrieve the return line items associated to the return", "id": "fa1ad581-0487-426b-8a13-ec4da4e460a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "return_line_items" ], "variable": [ { "id": "5bf3126e-1a67-460b-87a9-54fbf031ca30", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the return line items associated to the return" }, "response": [ { "id": "5c17631c-a251-4e66-99c8-459526a42183", "name": "The return_line_items associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/return_line_items", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "return_line_items" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5c17631c-a251-4e66-99c8-459526a42183" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fa1ad581-0487-426b-8a13-ec4da4e460a9" } ], "id": "dc545985-3961-4116-8053-d555a7da01d4", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-dc545985-3961-4116-8053-d555a7da01d4" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the return", "id": "573ce898-f5a9-4cf7-8343-451e61b7201b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "attachments" ], "variable": [ { "id": "a881833b-287c-4a59-b921-26c6ff9cc039", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the return" }, "response": [ { "id": "f76264b1-4879-4964-b2f4-2325c3294c6d", "name": "The attachments associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "attachments" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f76264b1-4879-4964-b2f4-2325c3294c6d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-573ce898-f5a9-4cf7-8343-451e61b7201b" } ], "id": "37a42c2b-bd38-4f54-9095-bb929cc1553b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-37a42c2b-bd38-4f54-9095-bb929cc1553b" }, { "name": "resource_errors", "item": [ { "name": "Retrieve the resource errors associated to the return", "id": "089cd8d7-5a92-4165-907e-4ae12ff9ce6d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/resource_errors", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "resource_errors" ], "variable": [ { "id": "5a813714-35a9-4911-be27-8499b8b9dbca", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the resource errors associated to the return" }, "response": [ { "id": "c360dc06-2612-4cf2-8fd5-b34411857736", "name": "The resource_errors associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/resource_errors", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "resource_errors" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c360dc06-2612-4cf2-8fd5-b34411857736" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-089cd8d7-5a92-4165-907e-4ae12ff9ce6d" } ], "id": "75b95e0f-7906-411e-95b7-f36efb0a4a44", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-75b95e0f-7906-411e-95b7-f36efb0a4a44" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the return", "id": "55dcb9d0-fb22-4a06-a621-8fb65d436fdd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/events", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "events" ], "variable": [ { "id": "c1d17e4a-21d7-43ac-ae6d-792ec0944c2f", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the return" }, "response": [ { "id": "41ebe0dc-0e0f-4ae2-b19a-36a372c4050e", "name": "The events associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/events", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "events" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-41ebe0dc-0e0f-4ae2-b19a-36a372c4050e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-55dcb9d0-fb22-4a06-a621-8fb65d436fdd" } ], "id": "fe168899-7938-4730-acfa-95c50e52b115", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fe168899-7938-4730-acfa-95c50e52b115" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the return", "id": "2da2184e-b86d-4541-9d1b-ef711f9fbde5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/tags", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "tags" ], "variable": [ { "id": "8bfeb0b1-7d3a-4c3c-8396-04471dec9b90", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the return" }, "response": [ { "id": "324d05b5-ae28-496b-9d88-e5870f34d2fb", "name": "The tags associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/tags", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "tags" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-324d05b5-ae28-496b-9d88-e5870f34d2fb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2da2184e-b86d-4541-9d1b-ef711f9fbde5" } ], "id": "e9948d4c-75b7-462a-abe6-9f738bc35ac1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e9948d4c-75b7-462a-abe6-9f738bc35ac1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the return", "id": "0a097c6b-691c-4e14-9942-f08a68eecd5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "event_stores" ], "variable": [ { "id": "c770ca1f-209f-4623-a9e2-cae70c9178ba", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the return" }, "response": [ { "id": "a6f09448-b2f1-48ee-87b2-0cb25c6f7dc0", "name": "The event_stores associated to the return", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId", "event_stores" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a6f09448-b2f1-48ee-87b2-0cb25c6f7dc0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0a097c6b-691c-4e14-9942-f08a68eecd5a" } ], "id": "227825ad-ee2b-4f8b-a1a6-339617c30396", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-227825ad-ee2b-4f8b-a1a6-339617c30396" }, { "name": "Retrieve a return", "id": "f8e2e635-4916-4ee5-bbee-192d6a2ce8ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/returns/:returnId", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId" ], "variable": [ { "id": "4f55466b-a0bc-4789-9b31-f040bd417b68", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a return" }, "response": [ { "id": "fa770002-81ca-41bd-a750-c701de378916", "name": "The return object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"returns\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"draft\",\n \"customer_email\": \"\",\n \"skus_count\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"shipped_at\": \"\",\n \"rejected_at\": \"\",\n \"received_at\": \"\",\n \"refunded_at\": \"\",\n \"archived_at\": \"\",\n \"estimated_refund_amount_cents\": \"\",\n \"estimated_refund_amount_float\": \"\",\n \"formatted_estimated_refund_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"destination_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_address\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"reference_refund\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_refund\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa770002-81ca-41bd-a750-c701de378916" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f8e2e635-4916-4ee5-bbee-192d6a2ce8ec" }, { "name": "Update a return", "id": "ec6a7f36-9ff6-4771-826a-6132f9b07df7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\",\n \"attributes\": {\n \"_request\": \"\",\n \"_approve\": \"\",\n \"_cancel\": \"\",\n \"_ship\": \"\",\n \"_reject\": \"\",\n \"_receive\": \"\",\n \"_restock\": \"\",\n \"_archive\": \"\",\n \"_unarchive\": \"\",\n \"_refund\": \"\",\n \"_refund_amount_cents\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/returns/:returnId", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId" ], "variable": [ { "id": "155cb0f2-dcf3-4c90-945b-469705493952", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a return" }, "response": [ { "id": "91005e92-37bf-45ad-9f4a-85692d86d99d", "name": "The updated return object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"returns\",\n \"id\": \"\",\n \"attributes\": {\n \"_request\": \"\",\n \"_approve\": \"\",\n \"_cancel\": \"\",\n \"_ship\": \"\",\n \"_reject\": \"\",\n \"_receive\": \"\",\n \"_restock\": \"\",\n \"_archive\": \"\",\n \"_unarchive\": \"\",\n \"_refund\": \"\",\n \"_refund_amount_cents\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/returns/:returnId", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId" ], "variable": [ { "key": "returnId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"returns\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"draft\",\n \"customer_email\": \"\",\n \"skus_count\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"shipped_at\": \"\",\n \"rejected_at\": \"\",\n \"received_at\": \"\",\n \"refunded_at\": \"\",\n \"archived_at\": \"\",\n \"estimated_refund_amount_cents\": \"\",\n \"estimated_refund_amount_float\": \"\",\n \"formatted_estimated_refund_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"destination_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_address\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"reference_refund\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_refund\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-91005e92-37bf-45ad-9f4a-85692d86d99d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ec6a7f36-9ff6-4771-826a-6132f9b07df7" }, { "name": "Delete a return", "id": "39a54fd7-a819-424e-8fe1-3976d71da8d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/returns/:returnId", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId" ], "variable": [ { "id": "8ece6d1a-d582-4766-9e81-957aca2288cc", "key": "returnId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a return" }, "response": [ { "id": "f49c5d81-951b-4d4f-a97d-794477244683", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns/:returnId", "host": [ "{{baseUrl}}" ], "path": [ "returns", ":returnId" ], "variable": [ { "key": "returnId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f49c5d81-951b-4d4f-a97d-794477244683" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-39a54fd7-a819-424e-8fe1-3976d71da8d9" } ], "id": "1c0c01b3-322a-4826-8126-7457531601da", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1c0c01b3-322a-4826-8126-7457531601da" }, { "name": "List all returns", "id": "e6427269-bd60-475b-88c1-d0dc66b430e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/returns", "host": [ "{{baseUrl}}" ], "path": [ "returns" ] }, "description": "List all returns" }, "response": [ { "id": "6b389510-9c83-4b39-b343-e3c034915c52", "name": "A list of return objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/returns", "host": [ "{{baseUrl}}" ], "path": [ "returns" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"returns\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"cancelled\",\n \"customer_email\": \"\",\n \"skus_count\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"shipped_at\": \"\",\n \"rejected_at\": \"\",\n \"received_at\": \"\",\n \"refunded_at\": \"\",\n \"archived_at\": \"\",\n \"estimated_refund_amount_cents\": \"\",\n \"estimated_refund_amount_float\": \"\",\n \"formatted_estimated_refund_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"destination_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_address\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"reference_refund\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_refund\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"returns\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"requested\",\n \"customer_email\": \"\",\n \"skus_count\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"shipped_at\": \"\",\n \"rejected_at\": \"\",\n \"received_at\": \"\",\n \"refunded_at\": \"\",\n \"archived_at\": \"\",\n \"estimated_refund_amount_cents\": \"\",\n \"estimated_refund_amount_float\": \"\",\n \"formatted_estimated_refund_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"destination_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_address\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"reference_refund\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_refund\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6b389510-9c83-4b39-b343-e3c034915c52" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e6427269-bd60-475b-88c1-d0dc66b430e1" }, { "name": "Create a return", "id": "9568300d-7390-4ef3-915a-5fd0095c56ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"returns\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/returns", "host": [ "{{baseUrl}}" ], "path": [ "returns" ] }, "description": "Create a return" }, "response": [ { "id": "08f755e8-db82-4fc9-8ce3-12202d52c843", "name": "The created return object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"returns\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"data\": {\n \"type\": \"captures\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/returns", "host": [ "{{baseUrl}}" ], "path": [ "returns" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"returns\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"draft\",\n \"customer_email\": \"\",\n \"skus_count\": \"\",\n \"approved_at\": \"\",\n \"cancelled_at\": \"\",\n \"shipped_at\": \"\",\n \"rejected_at\": \"\",\n \"received_at\": \"\",\n \"refunded_at\": \"\",\n \"archived_at\": \"\",\n \"estimated_refund_amount_cents\": \"\",\n \"estimated_refund_amount_float\": \"\",\n \"formatted_estimated_refund_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"destination_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_address\",\n \"id\": \"\"\n }\n },\n \"reference_capture\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_capture\",\n \"id\": \"\"\n }\n },\n \"reference_refund\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_refund\",\n \"id\": \"\"\n }\n },\n \"return_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"return_line_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"resource_errors\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"resource_errors\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-08f755e8-db82-4fc9-8ce3-12202d52c843" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9568300d-7390-4ef3-915a-5fd0095c56ad" } ], "id": "d57d8892-b224-404f-beaa-04e90e8a8bf3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d57d8892-b224-404f-beaa-04e90e8a8bf3" }, { "name": "satispay_gateways", "item": [ { "name": "{satispayGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the satispay gateway", "id": "3fa43f06-8f95-4696-bee3-0b1a2400515f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId", "payment_methods" ], "variable": [ { "id": "ca33f402-087e-4083-92fb-e035b505c502", "key": "satispayGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the satispay gateway" }, "response": [ { "id": "110a9e66-69cb-45a0-8be1-54e929753cbd", "name": "The payment_methods associated to the satispay gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId", "payment_methods" ], "variable": [ { "key": "satispayGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-110a9e66-69cb-45a0-8be1-54e929753cbd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3fa43f06-8f95-4696-bee3-0b1a2400515f" } ], "id": "f8d46ecd-0f13-471d-bf66-c84ff1430553", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f8d46ecd-0f13-471d-bf66-c84ff1430553" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the satispay gateway", "id": "bf7092cf-c0e5-4eba-bf37-00c8d338c4fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId", "event_stores" ], "variable": [ { "id": "bceed9cf-8d27-47bd-a33e-10ba810eae53", "key": "satispayGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the satispay gateway" }, "response": [ { "id": "0123ea5d-8d70-4b46-a499-18da00c900b5", "name": "The event_stores associated to the satispay gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId", "event_stores" ], "variable": [ { "key": "satispayGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0123ea5d-8d70-4b46-a499-18da00c900b5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bf7092cf-c0e5-4eba-bf37-00c8d338c4fb" } ], "id": "ab6859cd-a876-47ea-806d-7234d40588ee", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ab6859cd-a876-47ea-806d-7234d40588ee" }, { "name": "satispay_payments", "item": [ { "name": "Retrieve the satispay payments associated to the satispay gateway", "id": "656e0250-773f-4036-8071-64eb8ffb92ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId/satispay_payments", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId", "satispay_payments" ], "variable": [ { "id": "a3721156-439d-45b3-8ba5-b74cdc132195", "key": "satispayGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the satispay payments associated to the satispay gateway" }, "response": [ { "id": "1a8414ea-b92a-4779-bdd6-aff8e7c8e56e", "name": "The satispay_payments associated to the satispay gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId/satispay_payments", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId", "satispay_payments" ], "variable": [ { "key": "satispayGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1a8414ea-b92a-4779-bdd6-aff8e7c8e56e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-656e0250-773f-4036-8071-64eb8ffb92ee" } ], "id": "a62297bc-4267-41ee-8ba1-137cb9c9ab7b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a62297bc-4267-41ee-8ba1-137cb9c9ab7b" }, { "name": "Retrieve a satispay gateway", "id": "4187b91c-e37e-405c-a912-b4d77413c773", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId" ], "variable": [ { "id": "20acbf5c-6f3d-4f57-9746-021fdd0cec41", "key": "satispayGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a satispay gateway" }, "response": [ { "id": "169bdfcc-b73e-4e5a-9415-183c7168be5d", "name": "The satispay gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId" ], "variable": [ { "key": "satispayGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"satispay_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"token\": \"\",\n \"key_id\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"satispay_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-169bdfcc-b73e-4e5a-9415-183c7168be5d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4187b91c-e37e-405c-a912-b4d77413c773" }, { "name": "Update a satispay gateway", "id": "ef0fa673-8b6c-45ec-8678-5976ee9f5810", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"satispay_payments\": {\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId" ], "variable": [ { "id": "e24893b0-a281-4a8a-b984-52918768ed82", "key": "satispayGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a satispay gateway" }, "response": [ { "id": "377fdbe0-90e7-4efc-8066-9ec6b4c48eff", "name": "The updated satispay gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"satispay_payments\": {\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId" ], "variable": [ { "key": "satispayGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"satispay_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"token\": \"\",\n \"key_id\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"satispay_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-377fdbe0-90e7-4efc-8066-9ec6b4c48eff" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ef0fa673-8b6c-45ec-8678-5976ee9f5810" }, { "name": "Delete a satispay gateway", "id": "39b3be6a-dfec-41dc-a459-146b6f28913b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId" ], "variable": [ { "id": "1629b531-caa1-405d-9aba-83e31b9d8ac5", "key": "satispayGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a satispay gateway" }, "response": [ { "id": "35935b2f-556e-443b-b14c-d9e95b2beb8c", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_gateways/:satispayGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways", ":satispayGatewayId" ], "variable": [ { "key": "satispayGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-35935b2f-556e-443b-b14c-d9e95b2beb8c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-39b3be6a-dfec-41dc-a459-146b6f28913b" } ], "id": "4a920ffc-11d4-4a70-9130-5e28ab77aa58", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4a920ffc-11d4-4a70-9130-5e28ab77aa58" }, { "name": "List all satispay gateways", "id": "45bf2058-5a89-4c67-adc2-5439a4a67547", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/satispay_gateways", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways" ] }, "description": "List all satispay gateways" }, "response": [ { "id": "f67cbec6-1a62-46da-b0d9-5fbdae3a1e1b", "name": "A list of satispay gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_gateways", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"satispay_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"token\": \"\",\n \"key_id\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"satispay_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"satispay_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"token\": \"\",\n \"key_id\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"satispay_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f67cbec6-1a62-46da-b0d9-5fbdae3a1e1b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-45bf2058-5a89-4c67-adc2-5439a4a67547" }, { "name": "Create a satispay gateway", "id": "073969c4-261e-4e95-81d2-25c6a644782d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"token\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"satispay_payments\": {\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_gateways", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways" ] }, "description": "Create a satispay gateway" }, "response": [ { "id": "e7c4b465-d90c-4cc9-afc6-8ccccce81634", "name": "The created satispay gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"token\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"satispay_payments\": {\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_gateways", "host": [ "{{baseUrl}}" ], "path": [ "satispay_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"satispay_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"token\": \"\",\n \"key_id\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"satispay_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e7c4b465-d90c-4cc9-afc6-8ccccce81634" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-073969c4-261e-4e95-81d2-25c6a644782d" } ], "id": "20d6354b-479e-41c5-a58c-2eac1c195d0c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-20d6354b-479e-41c5-a58c-2eac1c195d0c" }, { "name": "satispay_payments", "item": [ { "name": "{satispayPaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the satispay payment", "id": "38d7ef08-e31f-40ba-bc51-5172a07da555", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId", "order" ], "variable": [ { "id": "029269c6-c45a-41e7-bd52-8284962de650", "key": "satispayPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the satispay payment" }, "response": [ { "id": "cd22b003-d0db-414c-8e5a-3aea486f1a44", "name": "The order associated to the satispay payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId", "order" ], "variable": [ { "key": "satispayPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cd22b003-d0db-414c-8e5a-3aea486f1a44" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-38d7ef08-e31f-40ba-bc51-5172a07da555" } ], "id": "271798cc-9ffe-488c-be65-5de564d6bafa", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-271798cc-9ffe-488c-be65-5de564d6bafa" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the satispay payment", "id": "46186cd1-275a-491b-8905-aca5e041630b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId", "payment_gateway" ], "variable": [ { "id": "53c76a1d-735a-4e09-ba34-866adda883c4", "key": "satispayPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the satispay payment" }, "response": [ { "id": "79d2f727-8d1b-4bee-8d61-d4b45811c3f7", "name": "The payment_gateway associated to the satispay payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId", "payment_gateway" ], "variable": [ { "key": "satispayPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-79d2f727-8d1b-4bee-8d61-d4b45811c3f7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-46186cd1-275a-491b-8905-aca5e041630b" } ], "id": "3ffac754-720e-4a5e-befd-1fd46a2b71f9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3ffac754-720e-4a5e-befd-1fd46a2b71f9" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the satispay payment", "id": "fcc8cbab-df81-4ce2-b9f0-7a1084ad2ded", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId", "event_stores" ], "variable": [ { "id": "675b40b8-5cdd-4833-9e61-ae2e2d9a56cd", "key": "satispayPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the satispay payment" }, "response": [ { "id": "0f730bf4-8a7a-4218-bc00-c2218b9ea963", "name": "The event_stores associated to the satispay payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId", "event_stores" ], "variable": [ { "key": "satispayPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0f730bf4-8a7a-4218-bc00-c2218b9ea963" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fcc8cbab-df81-4ce2-b9f0-7a1084ad2ded" } ], "id": "c9b14e79-a192-4631-b9d3-c1b335846523", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c9b14e79-a192-4631-b9d3-c1b335846523" }, { "name": "Retrieve a satispay payment", "id": "9f527028-8bf3-4d5e-9dac-1f42f09d1c21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId" ], "variable": [ { "id": "6f60de0d-92ef-47ea-9266-ff7a0bb980e3", "key": "satispayPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a satispay payment" }, "response": [ { "id": "62cfa163-9c74-462c-bf8f-0bdacaf0cd9a", "name": "The satispay payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId" ], "variable": [ { "key": "satispayPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"satispay_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_id\": \"\",\n \"flow\": \"\",\n \"status\": \"\",\n \"redirect_url\": \"\",\n \"payment_url\": \"\",\n \"payment_response\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-62cfa163-9c74-462c-bf8f-0bdacaf0cd9a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9f527028-8bf3-4d5e-9dac-1f42f09d1c21" }, { "name": "Update a satispay payment", "id": "fe47630b-7386-4bb6-a016-b691cab27463", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"redirect_url\": \"\",\n \"_refresh\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId" ], "variable": [ { "id": "a717512c-411f-4bb8-9cd3-5c41c5091fc5", "key": "satispayPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a satispay payment" }, "response": [ { "id": "2fa13615-d333-448a-96bf-4c14f21296f3", "name": "The updated satispay payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"redirect_url\": \"\",\n \"_refresh\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId" ], "variable": [ { "key": "satispayPaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"satispay_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_id\": \"\",\n \"flow\": \"\",\n \"status\": \"\",\n \"redirect_url\": \"\",\n \"payment_url\": \"\",\n \"payment_response\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2fa13615-d333-448a-96bf-4c14f21296f3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fe47630b-7386-4bb6-a016-b691cab27463" }, { "name": "Delete a satispay payment", "id": "170e1182-5edb-49fb-b656-4c5231cec13f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId" ], "variable": [ { "id": "f65fed73-f2ad-4c8e-bb64-0396a303ae04", "key": "satispayPaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a satispay payment" }, "response": [ { "id": "202f106b-3620-45a1-ad9d-de6c3f0b128d", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_payments/:satispayPaymentId", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments", ":satispayPaymentId" ], "variable": [ { "key": "satispayPaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-202f106b-3620-45a1-ad9d-de6c3f0b128d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-170e1182-5edb-49fb-b656-4c5231cec13f" } ], "id": "f569e9ad-d37c-45b0-82c3-3c224acdca5b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f569e9ad-d37c-45b0-82c3-3c224acdca5b" }, { "name": "List all satispay payments", "id": "0269f2dd-6124-45c3-bcd4-f042b4d88f7f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/satispay_payments", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments" ] }, "description": "List all satispay payments" }, "response": [ { "id": "909465b6-2c62-452c-8fcc-30e70183f5d1", "name": "A list of satispay payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/satispay_payments", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"satispay_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_id\": \"\",\n \"flow\": \"\",\n \"status\": \"\",\n \"redirect_url\": \"\",\n \"payment_url\": \"\",\n \"payment_response\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"satispay_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_id\": \"\",\n \"flow\": \"\",\n \"status\": \"\",\n \"redirect_url\": \"\",\n \"payment_url\": \"\",\n \"payment_response\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-909465b6-2c62-452c-8fcc-30e70183f5d1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0269f2dd-6124-45c3-bcd4-f042b4d88f7f" }, { "name": "Create a satispay payment", "id": "f64b6851-8ac7-4f2d-82e8-6efd439a988a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_payments\",\n \"attributes\": {\n \"flow\": \"\",\n \"redirect_url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_payments", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments" ] }, "description": "Create a satispay payment" }, "response": [ { "id": "df1774f2-2a51-4e37-be5d-52c5299173af", "name": "The created satispay payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"satispay_payments\",\n \"attributes\": {\n \"flow\": \"\",\n \"redirect_url\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/satispay_payments", "host": [ "{{baseUrl}}" ], "path": [ "satispay_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"satispay_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_id\": \"\",\n \"flow\": \"\",\n \"status\": \"\",\n \"redirect_url\": \"\",\n \"payment_url\": \"\",\n \"payment_response\": {},\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df1774f2-2a51-4e37-be5d-52c5299173af" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f64b6851-8ac7-4f2d-82e8-6efd439a988a" } ], "id": "7d06b45f-0fae-49cc-969d-1f571b2e717f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7d06b45f-0fae-49cc-969d-1f571b2e717f" }, { "name": "shipments", "item": [ { "name": "{shipmentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the shipment", "id": "ff2cb4bd-b749-467a-8b3a-26e43ee0ec60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/order", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "order" ], "variable": [ { "id": "8932f3eb-9bab-4950-9295-2645085dfc54", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the shipment" }, "response": [ { "id": "e5fa5fea-04d9-4652-b8d9-27c151e3c989", "name": "The order associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/order", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "order" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e5fa5fea-04d9-4652-b8d9-27c151e3c989" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ff2cb4bd-b749-467a-8b3a-26e43ee0ec60" } ], "id": "7f71847f-440e-49cf-a18f-e43cb07b1f7e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7f71847f-440e-49cf-a18f-e43cb07b1f7e" }, { "name": "shipping_category", "item": [ { "name": "Retrieve the shipping category associated to the shipment", "id": "8aad01d9-cc5f-47d4-a0e5-bd2d1db3665a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/shipping_category", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "shipping_category" ], "variable": [ { "id": "29417da9-ca6f-4cb5-be9c-f5fbbd8e9529", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping category associated to the shipment" }, "response": [ { "id": "d7253acf-9a22-48e5-9a68-38a17dee62e9", "name": "The shipping_category associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/shipping_category", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "shipping_category" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d7253acf-9a22-48e5-9a68-38a17dee62e9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8aad01d9-cc5f-47d4-a0e5-bd2d1db3665a" } ], "id": "298f8b09-4c19-460a-a053-68bf5db65706", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-298f8b09-4c19-460a-a053-68bf5db65706" }, { "name": "inventory_stock_location", "item": [ { "name": "Retrieve the inventory stock location associated to the shipment", "id": "fb4396dd-81b6-4e1f-88ba-b0e05468a791", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/inventory_stock_location", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "inventory_stock_location" ], "variable": [ { "id": "ba7f2892-e37b-4d12-8473-d734b05416d0", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory stock location associated to the shipment" }, "response": [ { "id": "e83a3af8-679d-4221-9572-ec3f1262ff5a", "name": "The inventory_stock_location associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/inventory_stock_location", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "inventory_stock_location" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e83a3af8-679d-4221-9572-ec3f1262ff5a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb4396dd-81b6-4e1f-88ba-b0e05468a791" } ], "id": "9c75a4c9-d385-4546-9327-853c08dab18b", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9c75a4c9-d385-4546-9327-853c08dab18b" }, { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the shipment", "id": "99da3796-6692-4101-b90c-aeb3dfd6b8ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "stock_location" ], "variable": [ { "id": "d88dd2ad-047a-409c-950b-590ccc009f67", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the shipment" }, "response": [ { "id": "df7ce7c0-0027-4fb6-8441-cc55231d9587", "name": "The stock_location associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "stock_location" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df7ce7c0-0027-4fb6-8441-cc55231d9587" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-99da3796-6692-4101-b90c-aeb3dfd6b8ea" } ], "id": "172385f6-fa37-4691-b2b1-7e2671ef5f2e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-172385f6-fa37-4691-b2b1-7e2671ef5f2e" }, { "name": "origin_address", "item": [ { "name": "Retrieve the origin address associated to the shipment", "id": "01c134d8-484d-477b-bb48-e4ce6cb5b8fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/origin_address", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "origin_address" ], "variable": [ { "id": "f68ed53d-00ee-463c-9df8-7cf23f62bf86", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the origin address associated to the shipment" }, "response": [ { "id": "0c7d8ba3-0371-4017-9af8-28aede735a01", "name": "The origin_address associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/origin_address", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "origin_address" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0c7d8ba3-0371-4017-9af8-28aede735a01" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-01c134d8-484d-477b-bb48-e4ce6cb5b8fb" } ], "id": "510d805f-3212-46f2-bdfa-f7f6427b5d8d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-510d805f-3212-46f2-bdfa-f7f6427b5d8d" }, { "name": "shipping_address", "item": [ { "name": "Retrieve the shipping address associated to the shipment", "id": "2f630ff4-dcc1-4309-8964-65e916a733a4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/shipping_address", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "shipping_address" ], "variable": [ { "id": "b2d9457d-414f-4875-93aa-0c9d47f9be0d", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping address associated to the shipment" }, "response": [ { "id": "4c05fd15-353c-42f9-a644-9d38e2b78c88", "name": "The shipping_address associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/shipping_address", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "shipping_address" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4c05fd15-353c-42f9-a644-9d38e2b78c88" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2f630ff4-dcc1-4309-8964-65e916a733a4" } ], "id": "6b838072-a603-44d0-b253-c3de02831aa2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-6b838072-a603-44d0-b253-c3de02831aa2" }, { "name": "shipping_method", "item": [ { "name": "Retrieve the shipping method associated to the shipment", "id": "609225dc-a1f6-41ce-bf29-9e4e21c85aee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "shipping_method" ], "variable": [ { "id": "612b79ad-02f4-43e6-a5cc-67b4965aa5eb", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping method associated to the shipment" }, "response": [ { "id": "5e057b5c-1405-49be-a3c2-5bf45ec3c074", "name": "The shipping_method associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "shipping_method" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5e057b5c-1405-49be-a3c2-5bf45ec3c074" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-609225dc-a1f6-41ce-bf29-9e4e21c85aee" } ], "id": "7db79332-b960-4624-91e8-7912d2f4782f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7db79332-b960-4624-91e8-7912d2f4782f" }, { "name": "delivery_lead_time", "item": [ { "name": "Retrieve the delivery lead time associated to the shipment", "id": "4944f2a6-8198-411a-a868-813bce923322", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/delivery_lead_time", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "delivery_lead_time" ], "variable": [ { "id": "3037144b-e24f-4611-b026-7776bb5620d8", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the delivery lead time associated to the shipment" }, "response": [ { "id": "cc2bc7b0-8558-480a-b0f5-f60c241ee6db", "name": "The delivery_lead_time associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/delivery_lead_time", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "delivery_lead_time" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cc2bc7b0-8558-480a-b0f5-f60c241ee6db" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4944f2a6-8198-411a-a868-813bce923322" } ], "id": "bba96dfe-13a1-46ce-a2ca-c5b9235001e7", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-bba96dfe-13a1-46ce-a2ca-c5b9235001e7" }, { "name": "pickup", "item": [ { "name": "Retrieve the pickup associated to the shipment", "id": "948da3f5-e019-4cf7-89f7-eb75cd362d5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "pickup" ], "variable": [ { "id": "0f43c15f-895c-4304-9b81-2f11136d9a80", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the pickup associated to the shipment" }, "response": [ { "id": "cdf47bc3-96b4-4490-a140-94a9002fd0e3", "name": "The pickup associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "pickup" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cdf47bc3-96b4-4490-a140-94a9002fd0e3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-948da3f5-e019-4cf7-89f7-eb75cd362d5c" } ], "id": "a79af9c6-8e56-4518-90eb-ff7edceced6d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a79af9c6-8e56-4518-90eb-ff7edceced6d" }, { "name": "stock_line_items", "item": [ { "name": "Retrieve the stock line items associated to the shipment", "id": "e3bb0adc-5082-4382-80a3-1389156f10b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "stock_line_items" ], "variable": [ { "id": "d5addb62-1ab5-405b-bcab-d2fc9b429675", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock line items associated to the shipment" }, "response": [ { "id": "c8765e0a-0733-4020-af3b-c353addbf800", "name": "The stock_line_items associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "stock_line_items" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c8765e0a-0733-4020-af3b-c353addbf800" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e3bb0adc-5082-4382-80a3-1389156f10b6" } ], "id": "8f9eda3e-9912-42ad-a021-94a4e4b06e76", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8f9eda3e-9912-42ad-a021-94a4e4b06e76" }, { "name": "stock_transfers", "item": [ { "name": "Retrieve the stock transfers associated to the shipment", "id": "d03a958b-1797-471e-9675-3ed99692c30e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "stock_transfers" ], "variable": [ { "id": "77498386-1499-4829-9bdd-86a8d609aa93", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock transfers associated to the shipment" }, "response": [ { "id": "e198ef5d-abcb-468e-8674-a704d009700f", "name": "The stock_transfers associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "stock_transfers" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e198ef5d-abcb-468e-8674-a704d009700f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d03a958b-1797-471e-9675-3ed99692c30e" } ], "id": "71a03bf2-ae5d-4c09-8717-2b88dd7d2a16", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-71a03bf2-ae5d-4c09-8717-2b88dd7d2a16" }, { "name": "line_items", "item": [ { "name": "Retrieve the line items associated to the shipment", "id": "c599f590-ca94-474e-83f6-488363462dc8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/line_items", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "line_items" ], "variable": [ { "id": "58a83570-7acf-450a-8ff5-8e39b206230d", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line items associated to the shipment" }, "response": [ { "id": "528c64cc-d863-4d78-84eb-5fdd271bc3cb", "name": "The line_items associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/line_items", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "line_items" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-528c64cc-d863-4d78-84eb-5fdd271bc3cb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c599f590-ca94-474e-83f6-488363462dc8" } ], "id": "7b795ddb-aa5d-4857-af21-7fefd5af8ec3", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7b795ddb-aa5d-4857-af21-7fefd5af8ec3" }, { "name": "available_shipping_methods", "item": [ { "name": "Retrieve the available shipping methods associated to the shipment", "id": "3cbf7b21-6c50-4a2d-8bec-824b851b0514", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/available_shipping_methods", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "available_shipping_methods" ], "variable": [ { "id": "3e2df8f4-1030-41cf-89ac-533ae6d9c2e9", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the available shipping methods associated to the shipment" }, "response": [ { "id": "ceb8cd88-1f48-4666-a50f-5e402e7c938e", "name": "The available_shipping_methods associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/available_shipping_methods", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "available_shipping_methods" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ceb8cd88-1f48-4666-a50f-5e402e7c938e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3cbf7b21-6c50-4a2d-8bec-824b851b0514" } ], "id": "4fabd4a0-dab8-4c94-9c1e-ff2bffefb163", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4fabd4a0-dab8-4c94-9c1e-ff2bffefb163" }, { "name": "carrier_accounts", "item": [ { "name": "Retrieve the carrier accounts associated to the shipment", "id": "1e90063d-9a71-4ed3-84b1-f680b71b4da1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/carrier_accounts", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "carrier_accounts" ], "variable": [ { "id": "e2b4857a-73a2-4201-b438-edd7f4da8303", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the carrier accounts associated to the shipment" }, "response": [ { "id": "572c9746-f8b5-47fe-b954-28f967744681", "name": "The carrier_accounts associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/carrier_accounts", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "carrier_accounts" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-572c9746-f8b5-47fe-b954-28f967744681" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1e90063d-9a71-4ed3-84b1-f680b71b4da1" } ], "id": "7762bf9e-fd36-47c8-8aad-33f5243fc605", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7762bf9e-fd36-47c8-8aad-33f5243fc605" }, { "name": "parcels", "item": [ { "name": "Retrieve the parcels associated to the shipment", "id": "20f14940-1f33-4497-94d4-efecc45ecae3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "parcels" ], "variable": [ { "id": "11f3e930-8392-44c9-adbe-6cdb06cada72", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the parcels associated to the shipment" }, "response": [ { "id": "ec16aea5-556a-49ef-849a-b87f48ff18b5", "name": "The parcels associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/parcels", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "parcels" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ec16aea5-556a-49ef-849a-b87f48ff18b5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-20f14940-1f33-4497-94d4-efecc45ecae3" } ], "id": "b547c39f-fb7e-4478-aa95-dc5999c36c3c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b547c39f-fb7e-4478-aa95-dc5999c36c3c" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the shipment", "id": "f9ae9b0a-b349-4fe0-8689-0c2cc8d73f3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "attachments" ], "variable": [ { "id": "3e751048-eb83-4060-9e7d-d919232907d3", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the shipment" }, "response": [ { "id": "079c8b3f-35e6-4915-ab91-33f8a405bfb9", "name": "The attachments associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "attachments" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-079c8b3f-35e6-4915-ab91-33f8a405bfb9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f9ae9b0a-b349-4fe0-8689-0c2cc8d73f3c" } ], "id": "a9e4bb5f-c851-4914-9218-403d11c6f034", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a9e4bb5f-c851-4914-9218-403d11c6f034" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the shipment", "id": "35968563-2db5-4c2c-947b-cd62191f4b19", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/events", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "events" ], "variable": [ { "id": "4fbea81f-3c08-4c25-b51e-61a3f22e1a68", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the shipment" }, "response": [ { "id": "97209986-8632-40d9-9e65-02f47b5d905c", "name": "The events associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/events", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "events" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-97209986-8632-40d9-9e65-02f47b5d905c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-35968563-2db5-4c2c-947b-cd62191f4b19" } ], "id": "4c088406-2d3a-44b7-8aea-d0e300ab6093", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4c088406-2d3a-44b7-8aea-d0e300ab6093" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the shipment", "id": "b7b6c976-b587-496b-a6cd-4e0afe657855", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/tags", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "tags" ], "variable": [ { "id": "71155b0b-3397-4e31-9d23-c5c481675489", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the shipment" }, "response": [ { "id": "37fb3d45-0425-4062-a644-3b2b33944117", "name": "The tags associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/tags", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "tags" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-37fb3d45-0425-4062-a644-3b2b33944117" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b7b6c976-b587-496b-a6cd-4e0afe657855" } ], "id": "1daf0076-de23-430c-9c35-b63688b1b4c9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-1daf0076-de23-430c-9c35-b63688b1b4c9" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the shipment", "id": "431cff6b-7335-45c1-9808-133fe03d96e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "event_stores" ], "variable": [ { "id": "9c1a6f69-1fd4-48b7-aa11-a4e007e21741", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the shipment" }, "response": [ { "id": "5101e1f9-7ca7-4b0b-aa7d-6b7f87119ec0", "name": "The event_stores associated to the shipment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId", "event_stores" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5101e1f9-7ca7-4b0b-aa7d-6b7f87119ec0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-431cff6b-7335-45c1-9808-133fe03d96e1" } ], "id": "8ea38742-5cfb-4f32-806f-592201d499f0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-8ea38742-5cfb-4f32-806f-592201d499f0" }, { "name": "Retrieve a shipment", "id": "903c0e84-176c-4838-96c1-66e30cdb761d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId" ], "variable": [ { "id": "3aeef6d5-2e2f-4016-95d2-25b8449c45cf", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a shipment" }, "response": [ { "id": "0e707ceb-7ec0-42ab-a70b-8d86e58d0940", "name": "The shipment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"delivered\",\n \"currency_code\": \"\",\n \"cost_amount_cents\": \"\",\n \"cost_amount_float\": \"\",\n \"formatted_cost_amount\": \"\",\n \"skus_count\": \"\",\n \"selected_rate_id\": \"\",\n \"purchase_error_code\": \"\",\n \"purchase_error_message\": \"\",\n \"get_rates_started_at\": \"\",\n \"get_rates_completed_at\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\",\n \"purchase_failed_at\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"packing_at\": \"\",\n \"ready_to_ship_at\": \"\",\n \"shipped_at\": \"\",\n \"delivered_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_location\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time\",\n \"id\": \"\"\n }\n },\n \"pickup\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"pickup\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"available_shipping_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_shipping_methods\",\n \"id\": \"\"\n }\n },\n \"carrier_accounts\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0e707ceb-7ec0-42ab-a70b-8d86e58d0940" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-903c0e84-176c-4838-96c1-66e30cdb761d" }, { "name": "Update a shipment", "id": "e53687e5-0056-4bf8-99b3-56da390f7848", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\",\n \"attributes\": {\n \"number\": \"\",\n \"_upcoming\": \"\",\n \"_cancel\": \"\",\n \"_on_hold\": \"\",\n \"_picking\": \"\",\n \"_packing\": \"\",\n \"_ready_to_ship\": \"\",\n \"_ship\": \"\",\n \"_deliver\": \"\",\n \"_reserve_stock\": \"\",\n \"_release_stock\": \"\",\n \"_decrement_stock\": \"\",\n \"_get_rates\": \"\",\n \"selected_rate_id\": \"\",\n \"_purchase\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipments/:shipmentId", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId" ], "variable": [ { "id": "d06f89bc-0127-4022-a82c-aa1b33aa6778", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a shipment" }, "response": [ { "id": "aa70ec7a-90d2-477d-ab8a-d0b08d5174c9", "name": "The updated shipment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\",\n \"attributes\": {\n \"number\": \"\",\n \"_upcoming\": \"\",\n \"_cancel\": \"\",\n \"_on_hold\": \"\",\n \"_picking\": \"\",\n \"_packing\": \"\",\n \"_ready_to_ship\": \"\",\n \"_ship\": \"\",\n \"_deliver\": \"\",\n \"_reserve_stock\": \"\",\n \"_release_stock\": \"\",\n \"_decrement_stock\": \"\",\n \"_get_rates\": \"\",\n \"selected_rate_id\": \"\",\n \"_purchase\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipments/:shipmentId", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"delivered\",\n \"currency_code\": \"\",\n \"cost_amount_cents\": \"\",\n \"cost_amount_float\": \"\",\n \"formatted_cost_amount\": \"\",\n \"skus_count\": \"\",\n \"selected_rate_id\": \"\",\n \"purchase_error_code\": \"\",\n \"purchase_error_message\": \"\",\n \"get_rates_started_at\": \"\",\n \"get_rates_completed_at\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\",\n \"purchase_failed_at\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"packing_at\": \"\",\n \"ready_to_ship_at\": \"\",\n \"shipped_at\": \"\",\n \"delivered_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_location\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time\",\n \"id\": \"\"\n }\n },\n \"pickup\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"pickup\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"available_shipping_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_shipping_methods\",\n \"id\": \"\"\n }\n },\n \"carrier_accounts\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aa70ec7a-90d2-477d-ab8a-d0b08d5174c9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e53687e5-0056-4bf8-99b3-56da390f7848" }, { "name": "Delete a shipment", "id": "28473500-f704-477f-a87c-f8bafd411360", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId" ], "variable": [ { "id": "779e1634-402f-469a-acca-3ec5abcb4bb2", "key": "shipmentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a shipment" }, "response": [ { "id": "ad7ac25d-0f9b-4920-8571-8afe923c4cc9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments/:shipmentId", "host": [ "{{baseUrl}}" ], "path": [ "shipments", ":shipmentId" ], "variable": [ { "key": "shipmentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ad7ac25d-0f9b-4920-8571-8afe923c4cc9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-28473500-f704-477f-a87c-f8bafd411360" } ], "id": "90726ed3-6648-4fd0-9b33-65eda12bd209", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-90726ed3-6648-4fd0-9b33-65eda12bd209" }, { "name": "List all shipments", "id": "45ea54b4-0b26-4f8a-a8a2-4d7588efd1d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipments", "host": [ "{{baseUrl}}" ], "path": [ "shipments" ] }, "description": "List all shipments" }, "response": [ { "id": "100176aa-07b6-440f-973d-ff83f148a323", "name": "A list of shipment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipments", "host": [ "{{baseUrl}}" ], "path": [ "shipments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"picking\",\n \"currency_code\": \"\",\n \"cost_amount_cents\": \"\",\n \"cost_amount_float\": \"\",\n \"formatted_cost_amount\": \"\",\n \"skus_count\": \"\",\n \"selected_rate_id\": \"\",\n \"purchase_error_code\": \"\",\n \"purchase_error_message\": \"\",\n \"get_rates_started_at\": \"\",\n \"get_rates_completed_at\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\",\n \"purchase_failed_at\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"packing_at\": \"\",\n \"ready_to_ship_at\": \"\",\n \"shipped_at\": \"\",\n \"delivered_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_location\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time\",\n \"id\": \"\"\n }\n },\n \"pickup\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"pickup\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"available_shipping_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_shipping_methods\",\n \"id\": \"\"\n }\n },\n \"carrier_accounts\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"upcoming\",\n \"currency_code\": \"\",\n \"cost_amount_cents\": \"\",\n \"cost_amount_float\": \"\",\n \"formatted_cost_amount\": \"\",\n \"skus_count\": \"\",\n \"selected_rate_id\": \"\",\n \"purchase_error_code\": \"\",\n \"purchase_error_message\": \"\",\n \"get_rates_started_at\": \"\",\n \"get_rates_completed_at\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\",\n \"purchase_failed_at\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"packing_at\": \"\",\n \"ready_to_ship_at\": \"\",\n \"shipped_at\": \"\",\n \"delivered_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_location\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time\",\n \"id\": \"\"\n }\n },\n \"pickup\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"pickup\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"available_shipping_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_shipping_methods\",\n \"id\": \"\"\n }\n },\n \"carrier_accounts\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-100176aa-07b6-440f-973d-ff83f148a323" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-45ea54b4-0b26-4f8a-a8a2-4d7588efd1d6" }, { "name": "Create a shipment", "id": "290da73b-1cb8-448a-a527-481dc6aec0b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipments\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipments", "host": [ "{{baseUrl}}" ], "path": [ "shipments" ] }, "description": "Create a shipment" }, "response": [ { "id": "2e158113-4bc1-4831-b369-3c3ffbaa68cc", "name": "The created shipment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipments\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipments", "host": [ "{{baseUrl}}" ], "path": [ "shipments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"status\": \"delivered\",\n \"currency_code\": \"\",\n \"cost_amount_cents\": \"\",\n \"cost_amount_float\": \"\",\n \"formatted_cost_amount\": \"\",\n \"skus_count\": \"\",\n \"selected_rate_id\": \"\",\n \"purchase_error_code\": \"\",\n \"purchase_error_message\": \"\",\n \"get_rates_started_at\": \"\",\n \"get_rates_completed_at\": \"\",\n \"purchase_started_at\": \"\",\n \"purchase_completed_at\": \"\",\n \"purchase_failed_at\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"packing_at\": \"\",\n \"ready_to_ship_at\": \"\",\n \"shipped_at\": \"\",\n \"delivered_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_location\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"origin_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_address\",\n \"id\": \"\"\n }\n },\n \"shipping_address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_address\",\n \"id\": \"\"\n }\n },\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time\",\n \"id\": \"\"\n }\n },\n \"pickup\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"pickup\",\n \"id\": \"\"\n }\n },\n \"stock_line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"line_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"available_shipping_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"available_shipping_methods\",\n \"id\": \"\"\n }\n },\n \"carrier_accounts\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"carrier_accounts\",\n \"id\": \"\"\n }\n },\n \"parcels\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"parcels\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2e158113-4bc1-4831-b369-3c3ffbaa68cc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-290da73b-1cb8-448a-a527-481dc6aec0b5" } ], "id": "e1391c81-860b-4cf5-8576-a84291adbcab", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e1391c81-860b-4cf5-8576-a84291adbcab" }, { "name": "shipping_categories", "item": [ { "name": "{shippingCategoryId}", "item": [ { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the shipping category", "id": "4ce8041f-ac18-4e8b-9f34-96367eac8f5b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId/skus", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId", "skus" ], "variable": [ { "id": "3cb05b8c-2cae-4d40-8de3-20cb10790f5b", "key": "shippingCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the shipping category" }, "response": [ { "id": "f24ea465-778e-47e6-8f84-e17971c02fef", "name": "The skus associated to the shipping category", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId/skus", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId", "skus" ], "variable": [ { "key": "shippingCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f24ea465-778e-47e6-8f84-e17971c02fef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4ce8041f-ac18-4e8b-9f34-96367eac8f5b" } ], "id": "9243fdd6-d58d-4819-ae12-0bbc1b93d540", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-9243fdd6-d58d-4819-ae12-0bbc1b93d540" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the shipping category", "id": "fbe8d5e3-547b-4734-805d-948092ad0dcb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId", "attachments" ], "variable": [ { "id": "732d3b2f-499a-48f1-9ea4-3b4b63dda838", "key": "shippingCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the shipping category" }, "response": [ { "id": "e9838862-67b0-43cb-9d62-57106ef21c4f", "name": "The attachments associated to the shipping category", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId", "attachments" ], "variable": [ { "key": "shippingCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e9838862-67b0-43cb-9d62-57106ef21c4f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fbe8d5e3-547b-4734-805d-948092ad0dcb" } ], "id": "a5dc878e-b9fd-43f8-a4d6-742e8ef7f8b5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a5dc878e-b9fd-43f8-a4d6-742e8ef7f8b5" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the shipping category", "id": "c94cb69a-698b-45f2-9856-8ca32c9d6d2f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId", "event_stores" ], "variable": [ { "id": "8d39cb5f-c828-49d9-a96e-4ea5fd96d0c6", "key": "shippingCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the shipping category" }, "response": [ { "id": "e5963c0e-9829-4bc3-ae1f-790d9707d0e0", "name": "The event_stores associated to the shipping category", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId", "event_stores" ], "variable": [ { "key": "shippingCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e5963c0e-9829-4bc3-ae1f-790d9707d0e0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c94cb69a-698b-45f2-9856-8ca32c9d6d2f" } ], "id": "214a6216-3f6a-428e-bde2-65439b967519", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-214a6216-3f6a-428e-bde2-65439b967519" }, { "name": "Retrieve a shipping category", "id": "df3b3625-f00d-4638-bec3-2ce71adb81ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId" ], "variable": [ { "id": "5fc95392-4fe3-4c5f-8f61-7e55ebd5e3e5", "key": "shippingCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a shipping category" }, "response": [ { "id": "8c5ef483-754f-48af-a58c-6bbfe34a96d5", "name": "The shipping category object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId" ], "variable": [ { "key": "shippingCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8c5ef483-754f-48af-a58c-6bbfe34a96d5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-df3b3625-f00d-4638-bec3-2ce71adb81ed" }, { "name": "Update a shipping category", "id": "ccb30fc5-2b66-474a-a974-9edbb3b9742c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId" ], "variable": [ { "id": "06dabc4c-a5d8-4bce-9b68-24ca435e2f2d", "key": "shippingCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a shipping category" }, "response": [ { "id": "cb2b1162-190a-401a-8009-bb077dfe64d4", "name": "The updated shipping category object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId" ], "variable": [ { "key": "shippingCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cb2b1162-190a-401a-8009-bb077dfe64d4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ccb30fc5-2b66-474a-a974-9edbb3b9742c" }, { "name": "Delete a shipping category", "id": "c4fb43d9-a3f9-4b23-9e25-f3b9fc1817d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId" ], "variable": [ { "id": "6a8b333b-8438-4d10-827a-c72eeb04323b", "key": "shippingCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a shipping category" }, "response": [ { "id": "a5e67ed1-b696-4dec-8605-3b21aa3de6c5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_categories/:shippingCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories", ":shippingCategoryId" ], "variable": [ { "key": "shippingCategoryId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a5e67ed1-b696-4dec-8605-3b21aa3de6c5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c4fb43d9-a3f9-4b23-9e25-f3b9fc1817d4" } ], "id": "cd152b9f-1dca-41e9-a2fa-7b303bc1381d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cd152b9f-1dca-41e9-a2fa-7b303bc1381d" }, { "name": "List all shipping categories", "id": "8afbef46-17df-44e9-ae38-fd0ffc8b116d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_categories", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories" ] }, "description": "List all shipping categories" }, "response": [ { "id": "899e65d5-2437-443b-898f-ed72b896f628", "name": "A list of shipping category objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_categories", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipping_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipping_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-899e65d5-2437-443b-898f-ed72b896f628" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8afbef46-17df-44e9-ae38-fd0ffc8b116d" }, { "name": "Create a shipping category", "id": "d6bb1bc5-c7e7-4ae3-89e6-1c5acdc12651", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_categories\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_categories", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories" ] }, "description": "Create a shipping category" }, "response": [ { "id": "8ae27dda-2f56-4342-9c31-fa0ab87c2587", "name": "The created shipping category object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_categories\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_categories", "host": [ "{{baseUrl}}" ], "path": [ "shipping_categories" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8ae27dda-2f56-4342-9c31-fa0ab87c2587" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d6bb1bc5-c7e7-4ae3-89e6-1c5acdc12651" } ], "id": "fe0a66d9-b5e7-42d5-8580-51b806068454", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fe0a66d9-b5e7-42d5-8580-51b806068454" }, { "name": "shipping_method_tiers", "item": [ { "name": "{shippingMethodTierId}", "item": [ { "name": "shipping_method", "item": [ { "name": "Retrieve the shipping method associated to the shipping method tier", "id": "463f5b61-b4e6-49f6-9146-e099ead9bbdb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId", "shipping_method" ], "variable": [ { "id": "f2d62fec-e475-41ac-a1da-9eb6b3684c2f", "key": "shippingMethodTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping method associated to the shipping method tier" }, "response": [ { "id": "30df8630-153f-44a9-a247-63134cb7ae37", "name": "The shipping_method associated to the shipping method tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId", "shipping_method" ], "variable": [ { "key": "shippingMethodTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-30df8630-153f-44a9-a247-63134cb7ae37" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-463f5b61-b4e6-49f6-9146-e099ead9bbdb" } ], "id": "59a1c6ff-75fe-4029-9a54-21310caad0d9", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-59a1c6ff-75fe-4029-9a54-21310caad0d9" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the shipping method tier", "id": "f764bb2b-08fa-40c5-bd90-c6c6d013f6ec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId", "attachments" ], "variable": [ { "id": "07df203f-b0c2-4fd5-b6c9-c6e3b2f50a0f", "key": "shippingMethodTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the shipping method tier" }, "response": [ { "id": "cb5c95e2-b23d-4eea-a6cb-1e2578bbf31f", "name": "The attachments associated to the shipping method tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId", "attachments" ], "variable": [ { "key": "shippingMethodTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cb5c95e2-b23d-4eea-a6cb-1e2578bbf31f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f764bb2b-08fa-40c5-bd90-c6c6d013f6ec" } ], "id": "b7fa714a-1ea4-470b-afb7-534108de950e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b7fa714a-1ea4-470b-afb7-534108de950e" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the shipping method tier", "id": "b219f72f-edd3-48a7-af47-a2eb1de4bc4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId", "event_stores" ], "variable": [ { "id": "78dc92c9-d75f-4d40-880b-e135d19e424f", "key": "shippingMethodTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the shipping method tier" }, "response": [ { "id": "90b54027-c135-4803-95d6-4604761ea3ee", "name": "The event_stores associated to the shipping method tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId", "event_stores" ], "variable": [ { "key": "shippingMethodTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-90b54027-c135-4803-95d6-4604761ea3ee" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b219f72f-edd3-48a7-af47-a2eb1de4bc4d" } ], "id": "2fc1c177-464d-482a-8e5d-f8c4d56c4ff0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2fc1c177-464d-482a-8e5d-f8c4d56c4ff0" }, { "name": "Retrieve a shipping method tier", "id": "b6577f3e-d524-4288-be89-74e248188c0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId" ], "variable": [ { "id": "86cb111e-6730-4da0-8e5c-4f74e2188ba3", "key": "shippingMethodTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a shipping method tier" }, "response": [ { "id": "ab143fa8-27a7-4bb2-9054-edca649583ea", "name": "The shipping method tier object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers/:shippingMethodTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers", ":shippingMethodTierId" ], "variable": [ { "key": "shippingMethodTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_method_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ab143fa8-27a7-4bb2-9054-edca649583ea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b6577f3e-d524-4288-be89-74e248188c0c" } ], "id": "d7e84443-23b5-477b-ab5c-b7a4740b1f8a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d7e84443-23b5-477b-ab5c-b7a4740b1f8a" }, { "name": "List all shipping method tiers", "id": "a720e78f-206a-4b47-8127-cb6bdeb2cff4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers" ] }, "description": "List all shipping method tiers" }, "response": [ { "id": "bcdda511-9e50-4278-ac72-4b7dbf2257d4", "name": "A list of shipping method tier objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_method_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_method_tiers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipping_method_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipping_method_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bcdda511-9e50-4278-ac72-4b7dbf2257d4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a720e78f-206a-4b47-8127-cb6bdeb2cff4" } ], "id": "5018b025-f711-43c1-bf2e-f07251862566", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5018b025-f711-43c1-bf2e-f07251862566" }, { "name": "shipping_methods", "item": [ { "name": "{shippingMethodId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the shipping method", "id": "1bc8cddc-1902-42ad-8805-496f5fab828b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/market", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "market" ], "variable": [ { "id": "de2c9406-68fa-4f57-8d20-89266ee72673", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the shipping method" }, "response": [ { "id": "164628be-d3c1-4921-89cc-b407c8fb32df", "name": "The market associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/market", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "market" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-164628be-d3c1-4921-89cc-b407c8fb32df" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1bc8cddc-1902-42ad-8805-496f5fab828b" } ], "id": "b3f63213-695d-4559-9797-bae82c19dade", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b3f63213-695d-4559-9797-bae82c19dade" }, { "name": "shipping_zone", "item": [ { "name": "Retrieve the shipping zone associated to the shipping method", "id": "41b2399e-a578-4fb2-923b-27c36ee21c31", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_zone", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_zone" ], "variable": [ { "id": "a628fa9c-119d-4d92-b841-a53c3c0c8945", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping zone associated to the shipping method" }, "response": [ { "id": "588df5a9-2428-446b-8443-fba32fa4944e", "name": "The shipping_zone associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_zone", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_zone" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-588df5a9-2428-446b-8443-fba32fa4944e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-41b2399e-a578-4fb2-923b-27c36ee21c31" } ], "id": "f3e78a12-ed89-4bd1-be26-14a0f34b5e2d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f3e78a12-ed89-4bd1-be26-14a0f34b5e2d" }, { "name": "shipping_category", "item": [ { "name": "Retrieve the shipping category associated to the shipping method", "id": "af7d0ce5-6307-49f9-a2ce-489f36e39a9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_category", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_category" ], "variable": [ { "id": "7b5451e8-e3ee-4b0c-8f1f-3349d839afab", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping category associated to the shipping method" }, "response": [ { "id": "52de3aff-a2e4-46c0-9db3-56e56efa3c21", "name": "The shipping_category associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_category", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_category" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-52de3aff-a2e4-46c0-9db3-56e56efa3c21" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-af7d0ce5-6307-49f9-a2ce-489f36e39a9b" } ], "id": "99332d04-1746-4efa-9296-6328dfdaa18f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-99332d04-1746-4efa-9296-6328dfdaa18f" }, { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the shipping method", "id": "0205ef63-6f56-405c-8b6d-a960feae5a58", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "stock_location" ], "variable": [ { "id": "fc51fde5-e543-4083-a2c8-8b91a759a394", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the shipping method" }, "response": [ { "id": "f3002a37-e17e-4c2d-ac38-b04c6c6e9f4e", "name": "The stock_location associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "stock_location" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f3002a37-e17e-4c2d-ac38-b04c6c6e9f4e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0205ef63-6f56-405c-8b6d-a960feae5a58" } ], "id": "fd0315ad-dee9-4bc8-bc16-ab5db45ca548", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fd0315ad-dee9-4bc8-bc16-ab5db45ca548" }, { "name": "delivery_lead_time_for_shipment", "item": [ { "name": "Retrieve the delivery lead time for shipment associated to the shipping method", "id": "ff7c0f02-afcc-4b7f-8782-4fbf78858281", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/delivery_lead_time_for_shipment", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "delivery_lead_time_for_shipment" ], "variable": [ { "id": "869c55a2-4f8c-4c2e-8a02-4b9cb9d2f28d", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the delivery lead time for shipment associated to the shipping method" }, "response": [ { "id": "161bf0e1-8f55-432b-bea1-6e9bd16f3956", "name": "The delivery_lead_time_for_shipment associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/delivery_lead_time_for_shipment", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "delivery_lead_time_for_shipment" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-161bf0e1-8f55-432b-bea1-6e9bd16f3956" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ff7c0f02-afcc-4b7f-8782-4fbf78858281" } ], "id": "f6f8c897-41b6-476d-90d3-b6c5309a055d", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f6f8c897-41b6-476d-90d3-b6c5309a055d" }, { "name": "shipping_method_tiers", "item": [ { "name": "Retrieve the shipping method tiers associated to the shipping method", "id": "f372d634-220b-4512-8cf3-19e59ff47323", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_method_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_method_tiers" ], "variable": [ { "id": "fcea3eab-2e04-4cbf-bee6-bc8b071f8755", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping method tiers associated to the shipping method" }, "response": [ { "id": "af37cc4f-9381-4f80-aeb6-44046e15210d", "name": "The shipping_method_tiers associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_method_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_method_tiers" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-af37cc4f-9381-4f80-aeb6-44046e15210d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f372d634-220b-4512-8cf3-19e59ff47323" } ], "id": "fdb02fec-2ee7-46a5-9720-b4def6c64061", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-fdb02fec-2ee7-46a5-9720-b4def6c64061" }, { "name": "shipping_weight_tiers", "item": [ { "name": "Retrieve the shipping weight tiers associated to the shipping method", "id": "21972c72-09bd-44a4-99f2-6aec80b67dcb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_weight_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_weight_tiers" ], "variable": [ { "id": "32a5645b-fc6f-4889-b5d8-5734a08772ef", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping weight tiers associated to the shipping method" }, "response": [ { "id": "f4fe96b7-ac73-4f0f-82de-29b86559fa6b", "name": "The shipping_weight_tiers associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/shipping_weight_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "shipping_weight_tiers" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f4fe96b7-ac73-4f0f-82de-29b86559fa6b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-21972c72-09bd-44a4-99f2-6aec80b67dcb" } ], "id": "67234516-f97c-4220-9f08-cb27a0797c72", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-67234516-f97c-4220-9f08-cb27a0797c72" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the shipping method", "id": "803d51e2-7e3a-4f69-922e-3a84106c7bb4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "attachments" ], "variable": [ { "id": "a688a9ad-0994-424b-90f9-ba087f63f373", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the shipping method" }, "response": [ { "id": "0aa390cc-b46f-4237-8e79-ebd85e34c889", "name": "The attachments associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "attachments" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0aa390cc-b46f-4237-8e79-ebd85e34c889" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-803d51e2-7e3a-4f69-922e-3a84106c7bb4" } ], "id": "a33f413a-b7e8-4e81-83e2-354c90bda8ee", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-a33f413a-b7e8-4e81-83e2-354c90bda8ee" }, { "name": "notifications", "item": [ { "name": "Retrieve the notifications associated to the shipping method", "id": "6f4238cc-198f-49c8-b801-599795489016", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "notifications" ], "variable": [ { "id": "368811a1-1bd0-45e2-a337-f3e0429fd16e", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the notifications associated to the shipping method" }, "response": [ { "id": "a4e8747a-ad9c-4cb1-b65d-2e7967f8eed2", "name": "The notifications associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/notifications", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "notifications" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a4e8747a-ad9c-4cb1-b65d-2e7967f8eed2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f4238cc-198f-49c8-b801-599795489016" } ], "id": "2a2c1c49-47ba-4c98-989f-ce029c542cf2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-2a2c1c49-47ba-4c98-989f-ce029c542cf2" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the shipping method", "id": "7cdc7f96-02f2-4c44-a2de-467580fa1443", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/events", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "events" ], "variable": [ { "id": "45bfbca6-0040-4a15-a8ab-25bc9678af02", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the shipping method" }, "response": [ { "id": "6c8ee5f8-0822-40b6-a3c1-7fe2b267ade8", "name": "The events associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/events", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "events" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6c8ee5f8-0822-40b6-a3c1-7fe2b267ade8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7cdc7f96-02f2-4c44-a2de-467580fa1443" } ], "id": "ff6ddfe3-e0a9-49b2-908c-eab7a4becc0e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ff6ddfe3-e0a9-49b2-908c-eab7a4becc0e" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the shipping method", "id": "11b1e2ab-a672-4c02-87d2-6f4116f25692", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/tags", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "tags" ], "variable": [ { "id": "1529c65a-0da2-4bf7-aaf6-9b0a25e32441", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the shipping method" }, "response": [ { "id": "ab7010c7-f1e3-4bfe-951e-3a6b26b3e122", "name": "The tags associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/tags", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "tags" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ab7010c7-f1e3-4bfe-951e-3a6b26b3e122" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-11b1e2ab-a672-4c02-87d2-6f4116f25692" } ], "id": "4cf2b97b-8f57-458d-ab15-24da741b5265", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-4cf2b97b-8f57-458d-ab15-24da741b5265" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the shipping method", "id": "6d8f0e10-0bee-4ebe-9ee3-667911541521", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "event_stores" ], "variable": [ { "id": "4cace4bd-aa21-4e1c-b603-8fbd61588b52", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the shipping method" }, "response": [ { "id": "620ce3b8-c84e-476c-9f61-de363bb24d76", "name": "The event_stores associated to the shipping method", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId", "event_stores" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-620ce3b8-c84e-476c-9f61-de363bb24d76" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6d8f0e10-0bee-4ebe-9ee3-667911541521" } ], "id": "184878c5-2603-4c5d-9ebc-5cb1e94a3ac5", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-184878c5-2603-4c5d-9ebc-5cb1e94a3ac5" }, { "name": "Retrieve a shipping method", "id": "d61e592c-2f38-4ad6-8f80-b12ee4d82c5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId" ], "variable": [ { "id": "c67a712c-7a15-4b63-8b95-7634f1092a23", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a shipping method" }, "response": [ { "id": "c1c4a6e3-0776-4cff-b0de-8fa568c3b5d5", "name": "The shipping method object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"free_over_amount_cents\": \"\",\n \"free_over_amount_float\": \"\",\n \"formatted_free_over_amount\": \"\",\n \"use_subtotal\": \"\",\n \"price_amount_for_shipment_cents\": \"\",\n \"price_amount_for_shipment_float\": \"\",\n \"formatted_price_amount_for_shipment\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"tax_code\": \"\",\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_zone\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time_for_shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time_for_shipment\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"shipping_weight_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c1c4a6e3-0776-4cff-b0de-8fa568c3b5d5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d61e592c-2f38-4ad6-8f80-b12ee4d82c5d" }, { "name": "Update a shipping method", "id": "643df8f6-2c5f-4323-ba43-9f3d3489fd00", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"free_over_amount_cents\": \"\",\n \"use_subtotal\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"tax_code\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"data\": {\n \"type\": \"shipping_zones\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId" ], "variable": [ { "id": "236b06c5-4cbc-442d-8f40-fa6615d491b6", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a shipping method" }, "response": [ { "id": "1e41ace4-4163-4526-b50d-db746b05c61c", "name": "The updated shipping method object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"free_over_amount_cents\": \"\",\n \"use_subtotal\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"tax_code\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_reset_circuit\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"data\": {\n \"type\": \"shipping_zones\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"free_over_amount_cents\": \"\",\n \"free_over_amount_float\": \"\",\n \"formatted_free_over_amount\": \"\",\n \"use_subtotal\": \"\",\n \"price_amount_for_shipment_cents\": \"\",\n \"price_amount_for_shipment_float\": \"\",\n \"formatted_price_amount_for_shipment\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"tax_code\": \"\",\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_zone\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time_for_shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time_for_shipment\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"shipping_weight_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1e41ace4-4163-4526-b50d-db746b05c61c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-643df8f6-2c5f-4323-ba43-9f3d3489fd00" }, { "name": "Delete a shipping method", "id": "1dce2557-fd66-40b4-96b4-3750755e4c33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId" ], "variable": [ { "id": "0a11d9e6-cc46-4862-af44-264bc2f07cf4", "key": "shippingMethodId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a shipping method" }, "response": [ { "id": "3fced067-707c-44e2-b347-8347130730ad", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods/:shippingMethodId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods", ":shippingMethodId" ], "variable": [ { "key": "shippingMethodId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3fced067-707c-44e2-b347-8347130730ad" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1dce2557-fd66-40b4-96b4-3750755e4c33" } ], "id": "23117885-708d-4622-8449-6207e810b8b2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-23117885-708d-4622-8449-6207e810b8b2" }, { "name": "List all shipping methods", "id": "b47ac968-266a-4c86-b118-579310415617", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_methods", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods" ] }, "description": "List all shipping methods" }, "response": [ { "id": "aec46f96-96bd-484e-9c8b-167716033b1b", "name": "A list of shipping method objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_methods", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipping_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"weight_tiered\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"free_over_amount_cents\": \"\",\n \"free_over_amount_float\": \"\",\n \"formatted_free_over_amount\": \"\",\n \"use_subtotal\": \"\",\n \"price_amount_for_shipment_cents\": \"\",\n \"price_amount_for_shipment_float\": \"\",\n \"formatted_price_amount_for_shipment\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"tax_code\": \"\",\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_zone\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time_for_shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time_for_shipment\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"shipping_weight_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipping_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"weight_tiered\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"free_over_amount_cents\": \"\",\n \"free_over_amount_float\": \"\",\n \"formatted_free_over_amount\": \"\",\n \"use_subtotal\": \"\",\n \"price_amount_for_shipment_cents\": \"\",\n \"price_amount_for_shipment_float\": \"\",\n \"formatted_price_amount_for_shipment\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"tax_code\": \"\",\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_zone\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time_for_shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time_for_shipment\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"shipping_weight_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aec46f96-96bd-484e-9c8b-167716033b1b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b47ac968-266a-4c86-b118-579310415617" }, { "name": "Create a shipping method", "id": "23200b5c-3ac0-4ad7-b482-f2d29580afb6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_methods\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"free_over_amount_cents\": \"\",\n \"use_subtotal\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"tax_code\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"data\": {\n \"type\": \"shipping_zones\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_methods", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods" ] }, "description": "Create a shipping method" }, "response": [ { "id": "10873be3-6e16-4562-9d24-886d6d114612", "name": "The created shipping method object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_methods\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"free_over_amount_cents\": \"\",\n \"use_subtotal\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"oz\",\n \"tax_code\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"data\": {\n \"type\": \"shipping_zones\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_methods", "host": [ "{{baseUrl}}" ], "path": [ "shipping_methods" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_methods\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"scheme\": \"flat\",\n \"currency_code\": \"\",\n \"external_prices_url\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"free_over_amount_cents\": \"\",\n \"free_over_amount_float\": \"\",\n \"formatted_free_over_amount\": \"\",\n \"use_subtotal\": \"\",\n \"price_amount_for_shipment_cents\": \"\",\n \"price_amount_for_shipment_float\": \"\",\n \"formatted_price_amount_for_shipment\": \"\",\n \"min_weight\": \"\",\n \"max_weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"tax_code\": \"\",\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"external_includes\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"shipping_zone\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_zone\",\n \"id\": \"\"\n }\n },\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_time_for_shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_time_for_shipment\",\n \"id\": \"\"\n }\n },\n \"shipping_method_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method_tiers\",\n \"id\": \"\"\n }\n },\n \"shipping_weight_tiers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"notifications\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"notifications\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-10873be3-6e16-4562-9d24-886d6d114612" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-23200b5c-3ac0-4ad7-b482-f2d29580afb6" } ], "id": "d9760309-52e3-4bb3-8abb-b7497e59a9e8", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d9760309-52e3-4bb3-8abb-b7497e59a9e8" }, { "name": "shipping_weight_tiers", "item": [ { "name": "{shippingWeightTierId}", "item": [ { "name": "shipping_method", "item": [ { "name": "Retrieve the shipping method associated to the shipping weight tier", "id": "7521f5a7-73f8-465c-acb3-520c4502a0db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "shipping_method" ], "variable": [ { "id": "117d2673-227b-4cd1-adb0-fb607515fb7e", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping method associated to the shipping weight tier" }, "response": [ { "id": "25cf83db-dd17-4542-b82a-ae5a697ba05d", "name": "The shipping_method associated to the shipping weight tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/shipping_method", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "shipping_method" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-25cf83db-dd17-4542-b82a-ae5a697ba05d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7521f5a7-73f8-465c-acb3-520c4502a0db" } ], "id": "d11d2908-2846-498e-b566-25d3f8f575ec", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d11d2908-2846-498e-b566-25d3f8f575ec" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the shipping weight tier", "id": "9a2a26fc-4a9a-49c1-bdf9-52b5e3814737", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "attachments" ], "variable": [ { "id": "db11b120-1a04-45a4-b4cb-8d2f4a4517a8", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the shipping weight tier" }, "response": [ { "id": "1979d76a-467d-434a-9620-78ac8f9ffe73", "name": "The attachments associated to the shipping weight tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "attachments" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1979d76a-467d-434a-9620-78ac8f9ffe73" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9a2a26fc-4a9a-49c1-bdf9-52b5e3814737" } ], "id": "373701c7-0a6c-46ba-88f9-6259723b8d25", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-373701c7-0a6c-46ba-88f9-6259723b8d25" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the shipping weight tier", "id": "c1a50294-6ab2-4139-80b1-294236d63f97", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "event_stores" ], "variable": [ { "id": "40d96b69-619c-4c3b-b18a-5444d076fd3a", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the shipping weight tier" }, "response": [ { "id": "263998e6-9bb1-4648-a02e-475b9851cd12", "name": "The event_stores associated to the shipping weight tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "event_stores" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-263998e6-9bb1-4648-a02e-475b9851cd12" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c1a50294-6ab2-4139-80b1-294236d63f97" } ], "id": "b95f9bd2-976d-4d6c-8225-9732ec7176ca", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-b95f9bd2-976d-4d6c-8225-9732ec7176ca" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the shipping weight tier", "id": "4bc258b1-af99-48b5-85ba-c77ff8cd65aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/events", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "events" ], "variable": [ { "id": "838dead0-9346-4549-bf9d-9888ea66fde1", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the shipping weight tier" }, "response": [ { "id": "563ecf39-230e-4355-9672-7dd08acb80b4", "name": "The events associated to the shipping weight tier", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId/events", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId", "events" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-563ecf39-230e-4355-9672-7dd08acb80b4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4bc258b1-af99-48b5-85ba-c77ff8cd65aa" } ], "id": "08d0244a-787b-46d3-aa32-649826a00261", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-08d0244a-787b-46d3-aa32-649826a00261" }, { "name": "Retrieve a shipping weight tier", "id": "3347c3c6-c900-4fe7-85a2-45431430bfc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId" ], "variable": [ { "id": "91333507-663f-4344-bb53-b3f947cd58c0", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a shipping weight tier" }, "response": [ { "id": "b55aae8a-ca15-4e77-8380-830df3049581", "name": "The shipping weight tier object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b55aae8a-ca15-4e77-8380-830df3049581" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3347c3c6-c900-4fe7-85a2-45431430bfc1" }, { "name": "Update a shipping weight tier", "id": "b559d75d-9bdf-4b79-a142-9c676b229000", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId" ], "variable": [ { "id": "7016c7bf-13ad-487f-be31-33ee6cc7e0fe", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a shipping weight tier" }, "response": [ { "id": "f44e4512-0b49-4c89-8a05-7eef18509830", "name": "The updated shipping weight tier object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f44e4512-0b49-4c89-8a05-7eef18509830" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b559d75d-9bdf-4b79-a142-9c676b229000" }, { "name": "Delete a shipping weight tier", "id": "c98ad094-8474-4e79-a311-deb87c3da55a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId" ], "variable": [ { "id": "9c33d012-120a-457d-bada-fca9129bec6f", "key": "shippingWeightTierId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a shipping weight tier" }, "response": [ { "id": "30c959cf-b4a9-4938-addc-aaef7cba972f", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers/:shippingWeightTierId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers", ":shippingWeightTierId" ], "variable": [ { "key": "shippingWeightTierId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-30c959cf-b4a9-4938-addc-aaef7cba972f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c98ad094-8474-4e79-a311-deb87c3da55a" } ], "id": "5978fd45-285c-499a-8a0c-4a7f226dd93f", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5978fd45-285c-499a-8a0c-4a7f226dd93f" }, { "name": "List all shipping weight tiers", "id": "0b4deef6-9acf-4625-b506-ea5417a5f1c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers" ] }, "description": "List all shipping weight tiers" }, "response": [ { "id": "54c15cce-697e-49c9-8396-43c362fea669", "name": "A list of shipping weight tier objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_weight_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-54c15cce-697e-49c9-8396-43c362fea669" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0b4deef6-9acf-4625-b506-ea5417a5f1c9" }, { "name": "Create a shipping weight tier", "id": "67944b6a-2412-4166-b44c-71f0c7355c9f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"up_to\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_weight_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers" ] }, "description": "Create a shipping weight tier" }, "response": [ { "id": "9beee280-ec6e-4147-9cf7-584cdb80adc3", "name": "The created shipping weight tier object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_weight_tiers\",\n \"attributes\": {\n \"name\": \"\",\n \"price_amount_cents\": \"\",\n \"up_to\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"data\": {\n \"type\": \"shipping_methods\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_weight_tiers", "host": [ "{{baseUrl}}" ], "path": [ "shipping_weight_tiers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"shipping_weight_tiers\",\n \"up_to\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_method\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_method\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9beee280-ec6e-4147-9cf7-584cdb80adc3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-67944b6a-2412-4166-b44c-71f0c7355c9f" } ], "id": "5455d9a8-59e9-4884-8d57-1f62e7ee085a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5455d9a8-59e9-4884-8d57-1f62e7ee085a" }, { "name": "shipping_zones", "item": [ { "name": "{shippingZoneId}", "item": [ { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the shipping zone", "id": "b712dcf8-5fda-469c-a938-c06b92aae1d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId", "attachments" ], "variable": [ { "id": "e06fa66d-3989-48ca-86c1-b328fc5a67a1", "key": "shippingZoneId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the shipping zone" }, "response": [ { "id": "47fb4f92-2f48-4bba-8f15-d3fffe895854", "name": "The attachments associated to the shipping zone", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId", "attachments" ], "variable": [ { "key": "shippingZoneId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-47fb4f92-2f48-4bba-8f15-d3fffe895854" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b712dcf8-5fda-469c-a938-c06b92aae1d2" } ], "id": "7956095e-83ee-4356-aa53-2d7c3df4a27a", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-7956095e-83ee-4356-aa53-2d7c3df4a27a" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the shipping zone", "id": "520c1edf-51d7-4a82-aee5-0a304bd7b6a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId", "event_stores" ], "variable": [ { "id": "1406439b-8686-4614-bfd7-a758176be259", "key": "shippingZoneId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the shipping zone" }, "response": [ { "id": "39668a81-1f4e-4ee4-8226-d27188ad3446", "name": "The event_stores associated to the shipping zone", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId", "event_stores" ], "variable": [ { "key": "shippingZoneId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-39668a81-1f4e-4ee4-8226-d27188ad3446" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-520c1edf-51d7-4a82-aee5-0a304bd7b6a2" } ], "id": "ea2f65cb-011e-4a03-8342-12bf09150ccb", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ea2f65cb-011e-4a03-8342-12bf09150ccb" }, { "name": "Retrieve a shipping zone", "id": "73dfe408-dff8-473f-bd69-e7d6e3b4e1f9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId" ], "variable": [ { "id": "8a15030e-642b-41ed-8904-1986ff91eac7", "key": "shippingZoneId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a shipping zone" }, "response": [ { "id": "c0bbcc38-113e-45a4-9c46-f889662c37f8", "name": "The shipping zone object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId" ], "variable": [ { "key": "shippingZoneId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_zones\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c0bbcc38-113e-45a4-9c46-f889662c37f8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-73dfe408-dff8-473f-bd69-e7d6e3b4e1f9" }, { "name": "Update a shipping zone", "id": "ac646e2e-987e-4121-ba0c-7cbad1ff23b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_zones\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId" ], "variable": [ { "id": "970877ef-6367-4051-8336-f4339d2134f9", "key": "shippingZoneId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a shipping zone" }, "response": [ { "id": "8335925d-1ff0-44e2-bb5c-30f57abd4052", "name": "The updated shipping zone object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_zones\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId" ], "variable": [ { "key": "shippingZoneId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_zones\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8335925d-1ff0-44e2-bb5c-30f57abd4052" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ac646e2e-987e-4121-ba0c-7cbad1ff23b8" }, { "name": "Delete a shipping zone", "id": "42ba9289-24f1-4b2e-b155-0123de0097a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId" ], "variable": [ { "id": "cb0fc47a-1ec3-413f-a549-94159b2a8bac", "key": "shippingZoneId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a shipping zone" }, "response": [ { "id": "0bf30b08-610c-4b24-9ca8-7ba862d72d53", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_zones/:shippingZoneId", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones", ":shippingZoneId" ], "variable": [ { "key": "shippingZoneId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0bf30b08-610c-4b24-9ca8-7ba862d72d53" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-42ba9289-24f1-4b2e-b155-0123de0097a3" } ], "id": "f51200bb-68de-4a2a-9d04-da298f4bad09", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-f51200bb-68de-4a2a-9d04-da298f4bad09" }, { "name": "List all shipping zones", "id": "f3003fa3-468a-41a4-a6aa-b14971511042", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/shipping_zones", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones" ] }, "description": "List all shipping zones" }, "response": [ { "id": "f43cfdec-6fc7-4e7d-b5b2-ba30b6f071e6", "name": "A list of shipping zone objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/shipping_zones", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"shipping_zones\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"shipping_zones\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f43cfdec-6fc7-4e7d-b5b2-ba30b6f071e6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f3003fa3-468a-41a4-a6aa-b14971511042" }, { "name": "Create a shipping zone", "id": "acf13610-ebbe-419c-ab46-ce759fe85e5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_zones\",\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_zones", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones" ] }, "description": "Create a shipping zone" }, "response": [ { "id": "fa94a982-57a2-43a5-afae-1b30ba53d8e4", "name": "The created shipping zone object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"shipping_zones\",\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/shipping_zones", "host": [ "{{baseUrl}}" ], "path": [ "shipping_zones" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"shipping_zones\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa94a982-57a2-43a5-afae-1b30ba53d8e4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-acf13610-ebbe-419c-ab46-ce759fe85e5d" } ], "id": "382fcb3a-e1ad-4db0-81c4-16f10447107e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-382fcb3a-e1ad-4db0-81c4-16f10447107e" }, { "name": "sku_list_items", "item": [ { "name": "{skuListItemId}", "item": [ { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the SKU list item", "id": "612dcc61-c01c-4784-9de6-ebb6f601528d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId", "sku_list" ], "variable": [ { "id": "9ffff2d3-7de9-4c74-a75c-f442c300a0dd", "key": "skuListItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the SKU list item" }, "response": [ { "id": "edde006e-9bda-4716-bbf0-549cbdf88ddb", "name": "The sku_list associated to the SKU list item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId", "sku_list" ], "variable": [ { "key": "skuListItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-edde006e-9bda-4716-bbf0-549cbdf88ddb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-612dcc61-c01c-4784-9de6-ebb6f601528d" } ], "id": "ace0dc0d-1b75-4ab4-af7d-891fd2a19765", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-ace0dc0d-1b75-4ab4-af7d-891fd2a19765" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the SKU list item", "id": "913b6b81-e9a1-44c7-8cc6-7e9a57e0d265", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId/sku", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId", "sku" ], "variable": [ { "id": "39dc129c-135d-4293-a414-6976035761ad", "key": "skuListItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the SKU list item" }, "response": [ { "id": "2f6c5cd3-fe06-43ea-bf6e-01beefcdd7d7", "name": "The sku associated to the SKU list item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId/sku", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId", "sku" ], "variable": [ { "key": "skuListItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2f6c5cd3-fe06-43ea-bf6e-01beefcdd7d7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-913b6b81-e9a1-44c7-8cc6-7e9a57e0d265" } ], "id": "d3d2648a-7c16-444d-89d0-6b737b5795f0", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-d3d2648a-7c16-444d-89d0-6b737b5795f0" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the SKU list item", "id": "2e0ecf51-9673-4f11-a6a6-d80a1d9872b4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId", "event_stores" ], "variable": [ { "id": "650b54ea-5ab0-4052-9414-ea264cfade0f", "key": "skuListItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the SKU list item" }, "response": [ { "id": "21f22dbf-681f-469b-bf93-20707a9feb22", "name": "The event_stores associated to the SKU list item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId", "event_stores" ], "variable": [ { "key": "skuListItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-21f22dbf-681f-469b-bf93-20707a9feb22" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2e0ecf51-9673-4f11-a6a6-d80a1d9872b4" } ], "id": "e0b1b6dc-67b7-4d18-9c1e-b71922207116", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-e0b1b6dc-67b7-4d18-9c1e-b71922207116" }, { "name": "Retrieve a SKU list item", "id": "e7cd8cf5-c09d-4c0f-997c-0fb09cb30656", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId" ], "variable": [ { "id": "dd4a2308-621f-43d0-9f1e-7fbbc1b8542c", "key": "skuListItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a SKU list item" }, "response": [ { "id": "d426d287-727d-4c9d-9ae0-717249d3c2f0", "name": "The SKU list item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId" ], "variable": [ { "key": "skuListItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_list_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d426d287-727d-4c9d-9ae0-717249d3c2f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e7cd8cf5-c09d-4c0f-997c-0fb09cb30656" }, { "name": "Update a SKU list item", "id": "c6c7c99c-3f2f-4ff0-890e-961f4d1bca91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\",\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId" ], "variable": [ { "id": "b69b8b87-1fd8-48dd-a827-924610e5313d", "key": "skuListItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a SKU list item" }, "response": [ { "id": "7b1bb046-4a17-41af-aca1-cb11b1e10a19", "name": "The updated SKU list item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\",\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId" ], "variable": [ { "key": "skuListItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_list_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7b1bb046-4a17-41af-aca1-cb11b1e10a19" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c6c7c99c-3f2f-4ff0-890e-961f4d1bca91" }, { "name": "Delete a SKU list item", "id": "bcc161bd-8359-451a-8aaf-00b57e2ef8df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId" ], "variable": [ { "id": "1544f82f-5a22-4686-a12d-ca9415e0211a", "key": "skuListItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a SKU list item" }, "response": [ { "id": "18b985d5-c60b-4b86-a679-e21a7b65e040", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_items/:skuListItemId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items", ":skuListItemId" ], "variable": [ { "key": "skuListItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-18b985d5-c60b-4b86-a679-e21a7b65e040" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bcc161bd-8359-451a-8aaf-00b57e2ef8df" } ], "id": "5aee6861-532e-487f-8d24-418f8fc03139", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-5aee6861-532e-487f-8d24-418f8fc03139" }, { "name": "List all SKU list items", "id": "78be0e00-9c09-4e79-bd03-c53c2e2afcce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items" ] }, "description": "List all SKU list items" }, "response": [ { "id": "1837c108-c985-4599-851b-f27e792b2766", "name": "A list of SKU list item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"sku_list_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"sku_list_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1837c108-c985-4599-851b-f27e792b2766" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-78be0e00-9c09-4e79-bd03-c53c2e2afcce" }, { "name": "Create a SKU list item", "id": "e68ce647-52c2-42ee-b239-c63ad82c3b42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_items\",\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items" ] }, "description": "Create a SKU list item" }, "response": [ { "id": "45a3614a-224c-458c-b8c9-fc42e7bfc4cd", "name": "The created SKU list item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_items\",\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_list_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"position\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-45a3614a-224c-458c-b8c9-fc42e7bfc4cd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e68ce647-52c2-42ee-b239-c63ad82c3b42" } ], "id": "c1cb748c-53f7-4989-8bd4-40d94237393c", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-c1cb748c-53f7-4989-8bd4-40d94237393c" }, { "name": "sku_list_promotion_rules", "item": [ { "name": "{skuListPromotionRuleId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the SKU list promotion rule", "id": "f3cdacac-c8e7-45f0-a423-1b061edc1031", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId", "event_stores" ], "variable": [ { "id": "db043a52-25d5-408d-9fdb-808d7f83f436", "key": "skuListPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the SKU list promotion rule" }, "response": [ { "id": "9984e209-5d26-4ce0-a2f4-668136c14cea", "name": "The event_stores associated to the SKU list promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId", "event_stores" ], "variable": [ { "key": "skuListPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9984e209-5d26-4ce0-a2f4-668136c14cea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f3cdacac-c8e7-45f0-a423-1b061edc1031" } ], "id": "cdf52fd5-db2c-4d06-887a-f95f8d5ab3d1", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cdf52fd5-db2c-4d06-887a-f95f8d5ab3d1" }, { "name": "sku_list", "item": [ { "name": "Retrieve the sku list associated to the SKU list promotion rule", "id": "12387f2e-cf20-4f85-9d30-7e6d1dc49bf4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId", "sku_list" ], "variable": [ { "id": "276d35ca-8463-4f4c-9617-a67534362ae5", "key": "skuListPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list associated to the SKU list promotion rule" }, "response": [ { "id": "deab2d03-300a-4cda-9be2-0ae82688c5a4", "name": "The sku_list associated to the SKU list promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId/sku_list", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId", "sku_list" ], "variable": [ { "key": "skuListPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-deab2d03-300a-4cda-9be2-0ae82688c5a4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-12387f2e-cf20-4f85-9d30-7e6d1dc49bf4" } ], "id": "81d819ec-5c36-4084-ba24-5bf7babb7bf2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-81d819ec-5c36-4084-ba24-5bf7babb7bf2" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the SKU list promotion rule", "id": "1f778b9c-55b8-4f9e-b778-963afffea2cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId/skus", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId", "skus" ], "variable": [ { "id": "503b9213-d3d0-4873-9f68-a2aab68239ce", "key": "skuListPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the SKU list promotion rule" }, "response": [ { "id": "31599ae1-d327-4bd1-8ab3-607cb1c61d8e", "name": "The skus associated to the SKU list promotion rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId/skus", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId", "skus" ], "variable": [ { "key": "skuListPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-31599ae1-d327-4bd1-8ab3-607cb1c61d8e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1f778b9c-55b8-4f9e-b778-963afffea2cd" } ], "id": "cb9f12e1-01e2-44f5-9c11-e200b5ebae03", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-cb9f12e1-01e2-44f5-9c11-e200b5ebae03" }, { "name": "Retrieve a SKU list promotion rule", "id": "d519feb2-5fa8-46ce-825e-3bca02d1f5bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId" ], "variable": [ { "id": "a7088226-bd18-4ba9-bb60-2773759e7f1b", "key": "skuListPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a SKU list promotion rule" }, "response": [ { "id": "838f8100-0dfe-444b-8e08-5333e08d6ad0", "name": "The SKU list promotion rule object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId" ], "variable": [ { "key": "skuListPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_list_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-838f8100-0dfe-444b-8e08-5333e08d6ad0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d519feb2-5fa8-46ce-825e-3bca02d1f5bf" }, { "name": "Update a SKU list promotion rule", "id": "fb2da951-59e8-442e-8007-80ea861fbe2f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId" ], "variable": [ { "id": "70ec02a0-fbac-4e4d-b68e-c7c7a092cfe0", "key": "skuListPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a SKU list promotion rule" }, "response": [ { "id": "35423808-355f-4d06-8054-c414bba62ffe", "name": "The updated SKU list promotion rule object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"active\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId" ], "variable": [ { "key": "skuListPromotionRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_list_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-35423808-355f-4d06-8054-c414bba62ffe" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb2da951-59e8-442e-8007-80ea861fbe2f" }, { "name": "Delete a SKU list promotion rule", "id": "344354c6-a342-409f-b337-092c773eff74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId" ], "variable": [ { "id": "8ad0932d-4dcb-47b8-82f2-0f1238e35444", "key": "skuListPromotionRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a SKU list promotion rule" }, "response": [ { "id": "c05d107c-3696-4501-ac7d-5d95ed449eef", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules/:skuListPromotionRuleId", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules", ":skuListPromotionRuleId" ], "variable": [ { "key": "skuListPromotionRuleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c05d107c-3696-4501-ac7d-5d95ed449eef" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-344354c6-a342-409f-b337-092c773eff74" } ], "id": "3c803bd6-e8ae-456c-ae26-0daa3bc2dac2", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-3c803bd6-e8ae-456c-ae26-0daa3bc2dac2" }, { "name": "List all SKU list promotion rules", "id": "b5d40f02-9684-46e4-8960-ae2a4e41b85c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules" ] }, "description": "List all SKU list promotion rules" }, "response": [ { "id": "a1d9a8dc-5afb-41a2-89ff-4735582ffc55", "name": "A list of SKU list promotion rule objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"sku_list_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"sku_list_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"order_amount_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a1d9a8dc-5afb-41a2-89ff-4735582ffc55" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b5d40f02-9684-46e4-8960-ae2a4e41b85c" }, { "name": "Create a SKU list promotion rule", "id": "177d465e-98ec-42ab-8647-c0344afd3d65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules" ] }, "description": "Create a SKU list promotion rule" }, "response": [ { "id": "5ca76203-1435-4bf5-ab5e-71778c9534ea", "name": "The created SKU list promotion rule object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"data\": {\n \"type\": \"percentage_discount_promotions\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"fixed_price_promotions\",\n \"currency_code\": \"\",\n \"exclusive\": \"\",\n \"priority\": \"\",\n \"starts_at\": \"\",\n \"expires_at\": \"\",\n \"total_usage_limit\": \"\",\n \"total_usage_count\": \"\",\n \"total_usage_reached\": \"\",\n \"active\": \"\",\n \"status\": \"expired\",\n \"weight\": \"\",\n \"coupons_count\": \"\",\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"percentage\": \"\"\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"promotion_rules\": {\n \"data\": {\n \"type\": \"promotion_rules\",\n \"id\": \"\"\n }\n },\n \"order_amount_promotion_rule\": {\n \"data\": {\n \"type\": \"order_amount_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list_promotion_rule\": {\n \"data\": {\n \"type\": \"sku_list_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"coupon_codes_promotion_rule\": {\n \"data\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"custom_promotion_rule\": {\n \"data\": {\n \"type\": \"custom_promotion_rules\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"coupons\": {\n \"data\": {\n \"type\": \"coupons\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n },\n \"sku_list\": {\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_list_promotion_rules", "host": [ "{{baseUrl}}" ], "path": [ "sku_list_promotion_rules" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_list_promotion_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"type\": \"coupon_codes_promotion_rules\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"all_skus\": \"\",\n \"min_quantity\": \"\"\n },\n \"relationships\": {\n \"promotion\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"promotion\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"sku_list\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5ca76203-1435-4bf5-ab5e-71778c9534ea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-177d465e-98ec-42ab-8647-c0344afd3d65" } ], "id": "334b0872-5fa5-451e-8b1b-ba8f831c054e", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-334b0872-5fa5-451e-8b1b-ba8f831c054e" }, { "name": "sku_lists", "item": [ { "name": "{skuListId}", "item": [ { "name": "customer", "item": [ { "name": "Retrieve the customer associated to the SKU list", "id": "1994fd12-2767-421d-a3e1-8caeb4ba9110", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/customer", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "customer" ], "variable": [ { "id": "a6ee360c-516f-4862-95cb-c463b6b5b7a8", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the customer associated to the SKU list" }, "response": [ { "id": "c35f67b2-4b3f-427e-825c-ea7b81a7e655", "name": "The customer associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/customer", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "customer" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c35f67b2-4b3f-427e-825c-ea7b81a7e655" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1994fd12-2767-421d-a3e1-8caeb4ba9110" } ], "id": "93331a94-3af0-425e-9aba-e7a1b58a0853", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-93331a94-3af0-425e-9aba-e7a1b58a0853" }, { "name": "skus", "item": [ { "name": "Retrieve the skus associated to the SKU list", "id": "7182ea03-ae61-45ce-b720-43f9cd43393f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/skus", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "skus" ], "variable": [ { "id": "9c497440-b55c-489b-b7fb-ada4c5826ae9", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the skus associated to the SKU list" }, "response": [ { "id": "dd715b4a-3762-4489-b579-94f809384daf", "name": "The skus associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/skus", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "skus" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dd715b4a-3762-4489-b579-94f809384daf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7182ea03-ae61-45ce-b720-43f9cd43393f" } ], "id": "ce3536a0-fbaa-4f4a-b210-ff018a873836", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ce3536a0-fbaa-4f4a-b210-ff018a873836" }, { "name": "sku_list_items", "item": [ { "name": "Retrieve the sku list items associated to the SKU list", "id": "e359018b-d4ca-40ae-8b32-291df58f83ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "sku_list_items" ], "variable": [ { "id": "d77c8199-ac8a-4d79-b67c-c7eee662e4f5", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list items associated to the SKU list" }, "response": [ { "id": "9a050314-00e2-4920-b473-7da999c4d3f0", "name": "The sku_list_items associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "sku_list_items" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9a050314-00e2-4920-b473-7da999c4d3f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e359018b-d4ca-40ae-8b32-291df58f83ac" } ], "id": "3f095d87-329a-44bc-a1f6-32e3249756e8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3f095d87-329a-44bc-a1f6-32e3249756e8" }, { "name": "bundles", "item": [ { "name": "Retrieve the bundles associated to the SKU list", "id": "686173bc-a2d5-4237-9e94-43308fa7a526", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/bundles", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "bundles" ], "variable": [ { "id": "7e407451-4d45-4a9d-984c-143f8af67c48", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the bundles associated to the SKU list" }, "response": [ { "id": "cdd2fe30-ab0e-40b5-89ef-abda17c1b430", "name": "The bundles associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/bundles", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "bundles" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cdd2fe30-ab0e-40b5-89ef-abda17c1b430" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-686173bc-a2d5-4237-9e94-43308fa7a526" } ], "id": "826dce32-e67b-46ad-a73c-164189fd434a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-826dce32-e67b-46ad-a73c-164189fd434a" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the SKU list", "id": "570675f5-cc29-4089-a99c-fc39db9131e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "attachments" ], "variable": [ { "id": "84829cd2-36e9-4736-bbbe-6d1a60b9978a", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the SKU list" }, "response": [ { "id": "6640eb52-87ad-471c-9659-a855045f0682", "name": "The attachments associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "attachments" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6640eb52-87ad-471c-9659-a855045f0682" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-570675f5-cc29-4089-a99c-fc39db9131e9" } ], "id": "7d100a1a-b7de-4150-bd93-eee8faeb6569", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7d100a1a-b7de-4150-bd93-eee8faeb6569" }, { "name": "links", "item": [ { "name": "Retrieve the links associated to the SKU list", "id": "64edc502-8bd5-43fb-a0b2-fd024bd5eb29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/links", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "links" ], "variable": [ { "id": "35cbf373-5367-4727-b234-5a110a025dfc", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the links associated to the SKU list" }, "response": [ { "id": "cb6258ed-0b6d-4b4a-be86-2cb2344751f5", "name": "The links associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/links", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "links" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cb6258ed-0b6d-4b4a-be86-2cb2344751f5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-64edc502-8bd5-43fb-a0b2-fd024bd5eb29" } ], "id": "07da185a-ac65-4c45-817f-cac45a384094", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07da185a-ac65-4c45-817f-cac45a384094" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the SKU list", "id": "4718ab09-8950-4a54-8987-13e0e805f8c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "event_stores" ], "variable": [ { "id": "94855eb8-6ad3-4bfd-b5bd-8ca8bca6d036", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the SKU list" }, "response": [ { "id": "ff750faf-1deb-4987-9b2b-a4f7ea95bc74", "name": "The event_stores associated to the SKU list", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId", "event_stores" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ff750faf-1deb-4987-9b2b-a4f7ea95bc74" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4718ab09-8950-4a54-8987-13e0e805f8c5" } ], "id": "c5e78fbe-ca51-4258-8360-7d233a569b7e", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c5e78fbe-ca51-4258-8360-7d233a569b7e" }, { "name": "Retrieve a SKU list", "id": "0cde9698-33e2-4eb6-a117-6093c5ecf5f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId" ], "variable": [ { "id": "a79522c7-5da2-497b-b3ed-a7b09c106968", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a SKU list" }, "response": [ { "id": "602e8b95-807a-4994-9f52-dd92cb75b690", "name": "The SKU list object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-602e8b95-807a-4994-9f52-dd92cb75b690" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0cde9698-33e2-4eb6-a117-6093c5ecf5f0" }, { "name": "Update a SKU list", "id": "b8b11d2f-b399-489b-9ed8-ecc20d5b577a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId" ], "variable": [ { "id": "1d085e47-6252-435c-a174-926696d349e6", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a SKU list" }, "response": [ { "id": "e3c0fb59-3faf-458e-b51a-c8848af18455", "name": "The updated SKU list object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId" ], "variable": [ { "key": "skuListId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3c0fb59-3faf-458e-b51a-c8848af18455" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b8b11d2f-b399-489b-9ed8-ecc20d5b577a" }, { "name": "Delete a SKU list", "id": "db470a2b-4c82-4276-8251-5a05bd9d1c82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId" ], "variable": [ { "id": "80ead23f-7491-4e49-a8ae-0507d51506f1", "key": "skuListId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a SKU list" }, "response": [ { "id": "73a02afa-bfcd-4fc2-9ba6-891c4c98b3e5", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists/:skuListId", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists", ":skuListId" ], "variable": [ { "key": "skuListId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-73a02afa-bfcd-4fc2-9ba6-891c4c98b3e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-db470a2b-4c82-4276-8251-5a05bd9d1c82" } ], "id": "612fbba8-a087-41ca-b892-d0c2cb560863", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-612fbba8-a087-41ca-b892-d0c2cb560863" }, { "name": "List all SKU lists", "id": "0a4be3c6-fc78-4025-baac-a314d6b8cdaf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists" ] }, "description": "List all SKU lists" }, "response": [ { "id": "34e697e5-5a8a-410c-87e9-88332a7819d1", "name": "A list of SKU list objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"sku_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"sku_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-34e697e5-5a8a-410c-87e9-88332a7819d1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0a4be3c6-fc78-4025-baac-a314d6b8cdaf" }, { "name": "Create a SKU list", "id": "0fa3753d-54c8-44e6-8cba-407a5c205ae9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_lists\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists" ] }, "description": "Create a SKU list" }, "response": [ { "id": "1d81153b-1518-48ba-bb30-f6dd36d5b103", "name": "The created SKU list object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_lists\",\n \"attributes\": {\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"data\": {\n \"type\": \"customers\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "sku_lists" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_lists\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"manual\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"customer\",\n \"id\": \"\"\n }\n },\n \"skus\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"bundles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"bundles\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1d81153b-1518-48ba-bb30-f6dd36d5b103" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0fa3753d-54c8-44e6-8cba-407a5c205ae9" } ], "id": "658f5f9a-4e31-495d-a45a-6a10d229adec", "createdAt": "2026-06-05T15:07:14.000Z", "updatedAt": "2026-06-05T15:07:14.000Z", "uid": "35240-658f5f9a-4e31-495d-a45a-6a10d229adec" }, { "name": "sku_options", "item": [ { "name": "{skuOptionId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the SKU option", "id": "5cd71876-90c4-4a2f-bfbf-671dfa2b3b8e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/market", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "market" ], "variable": [ { "id": "26440e85-fbd6-4017-b1b1-cf27c46de04e", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the SKU option" }, "response": [ { "id": "f590c4a2-3fd8-43fc-8539-d4fe884187c5", "name": "The market associated to the SKU option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/market", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "market" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f590c4a2-3fd8-43fc-8539-d4fe884187c5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5cd71876-90c4-4a2f-bfbf-671dfa2b3b8e" } ], "id": "72c03c18-4804-4f9f-b36b-19dc254fda39", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-72c03c18-4804-4f9f-b36b-19dc254fda39" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the SKU option", "id": "8829b54d-6416-4669-9104-4e97322a972c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "attachments" ], "variable": [ { "id": "a2e3b5e9-f91d-4a9c-a29f-d7477e1bea49", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the SKU option" }, "response": [ { "id": "b333599f-6b90-4c64-832a-fdf95f5cd9ba", "name": "The attachments associated to the SKU option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "attachments" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b333599f-6b90-4c64-832a-fdf95f5cd9ba" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8829b54d-6416-4669-9104-4e97322a972c" } ], "id": "99798ddd-617e-4471-b97b-147ee7d1fd98", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-99798ddd-617e-4471-b97b-147ee7d1fd98" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the SKU option", "id": "18c5f1f9-98b6-4479-afe6-c96e570689b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "events" ], "variable": [ { "id": "af2d542d-2efc-41a8-93e7-7a05c2310581", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the SKU option" }, "response": [ { "id": "bc5052d3-b3b8-42f0-b424-c0d21962d1f0", "name": "The events associated to the SKU option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/events", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "events" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bc5052d3-b3b8-42f0-b424-c0d21962d1f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-18c5f1f9-98b6-4479-afe6-c96e570689b3" } ], "id": "bcfff37e-f632-40dc-ba2a-5aded6a48c71", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bcfff37e-f632-40dc-ba2a-5aded6a48c71" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the SKU option", "id": "063b7f57-7a7f-443f-9315-44d87126dd32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "tags" ], "variable": [ { "id": "572f40a8-460c-48e5-92be-23efdc5bfd5b", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the SKU option" }, "response": [ { "id": "a8c37ec6-4bef-4318-898c-eadaf422271a", "name": "The tags associated to the SKU option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/tags", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "tags" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a8c37ec6-4bef-4318-898c-eadaf422271a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-063b7f57-7a7f-443f-9315-44d87126dd32" } ], "id": "0ff165a9-e8be-4b9a-8a43-1537995f18c1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0ff165a9-e8be-4b9a-8a43-1537995f18c1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the SKU option", "id": "c6bc2cf1-d006-4edd-8a52-d047860580a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "event_stores" ], "variable": [ { "id": "7fc6a77d-618d-4b21-9c5b-09b405963e13", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the SKU option" }, "response": [ { "id": "95db6d57-f607-435c-8eac-4c04673b1276", "name": "The event_stores associated to the SKU option", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId", "event_stores" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-95db6d57-f607-435c-8eac-4c04673b1276" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c6bc2cf1-d006-4edd-8a52-d047860580a7" } ], "id": "e7051f64-7884-4229-89bf-fcec38dacbc0", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e7051f64-7884-4229-89bf-fcec38dacbc0" }, { "name": "Retrieve a SKU option", "id": "9875219c-96aa-46e1-9011-4906d340e5e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId" ], "variable": [ { "id": "4eb4448b-bf62-46e9-a076-d4614fd05caa", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a SKU option" }, "response": [ { "id": "416f8461-ee0a-4ff5-a23a-4e309d5f6632", "name": "The SKU option object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-416f8461-ee0a-4ff5-a23a-4e309d5f6632" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9875219c-96aa-46e1-9011-4906d340e5e4" }, { "name": "Update a SKU option", "id": "f4a6a06e-fe75-4bd7-ad60-eea4e2ab401a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"delay_hours\": \"\",\n \"sku_code_regex\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId" ], "variable": [ { "id": "72e55588-943b-4907-82c1-bb7510ae9931", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a SKU option" }, "response": [ { "id": "bb556fe4-d186-425f-9d8b-3d385b94aa5f", "name": "The updated SKU option object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"delay_hours\": \"\",\n \"sku_code_regex\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bb556fe4-d186-425f-9d8b-3d385b94aa5f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f4a6a06e-fe75-4bd7-ad60-eea4e2ab401a" }, { "name": "Delete a SKU option", "id": "69228081-a6ba-4e8f-855e-3bb2cb508775", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId" ], "variable": [ { "id": "55c878c3-76ec-46b0-aa9b-5851648315f4", "key": "skuOptionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a SKU option" }, "response": [ { "id": "382ca7fb-de5d-4cbc-931e-dbf1b27087e2", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options/:skuOptionId", "host": [ "{{baseUrl}}" ], "path": [ "sku_options", ":skuOptionId" ], "variable": [ { "key": "skuOptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-382ca7fb-de5d-4cbc-931e-dbf1b27087e2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-69228081-a6ba-4e8f-855e-3bb2cb508775" } ], "id": "c122f376-9a62-45cb-ba33-8edfc0fc199b", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c122f376-9a62-45cb-ba33-8edfc0fc199b" }, { "name": "List all SKU options", "id": "03988c14-e066-4852-bf44-0ecadcace7cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/sku_options", "host": [ "{{baseUrl}}" ], "path": [ "sku_options" ] }, "description": "List all SKU options" }, "response": [ { "id": "4eea0015-4e88-44c1-827b-7b6159a1ff1d", "name": "A list of SKU option objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/sku_options", "host": [ "{{baseUrl}}" ], "path": [ "sku_options" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"sku_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"sku_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4eea0015-4e88-44c1-827b-7b6159a1ff1d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-03988c14-e066-4852-bf44-0ecadcace7cf" }, { "name": "Create a SKU option", "id": "b227cf8c-d6e1-4baf-a55f-973093841f95", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_options\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"delay_hours\": \"\",\n \"sku_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_options", "host": [ "{{baseUrl}}" ], "path": [ "sku_options" ] }, "description": "Create a SKU option" }, "response": [ { "id": "ae5c0976-f674-4e04-97a8-c1ee00aa8808", "name": "The created SKU option object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"sku_options\",\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"delay_hours\": \"\",\n \"sku_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sku_options", "host": [ "{{baseUrl}}" ], "path": [ "sku_options" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"sku_options\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"currency_code\": \"\",\n \"description\": \"\",\n \"price_amount_cents\": \"\",\n \"price_amount_float\": \"\",\n \"formatted_price_amount\": \"\",\n \"delay_hours\": \"\",\n \"delay_days\": \"\",\n \"sku_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ae5c0976-f674-4e04-97a8-c1ee00aa8808" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b227cf8c-d6e1-4baf-a55f-973093841f95" } ], "id": "8e9497a0-6f04-4531-ace0-2e50577ce97c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8e9497a0-6f04-4531-ace0-2e50577ce97c" }, { "name": "skus", "item": [ { "name": "{skuId}", "item": [ { "name": "shipping_category", "item": [ { "name": "Retrieve the shipping category associated to the SKU", "id": "484888b7-84dd-4946-b4a3-48b66e8236a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/shipping_category", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "shipping_category" ], "variable": [ { "id": "2745a257-aa5a-456a-b127-5b19a5249d32", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipping category associated to the SKU" }, "response": [ { "id": "e2440f25-9ddf-4bb0-88d7-82eba4338389", "name": "The shipping_category associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/shipping_category", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "shipping_category" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e2440f25-9ddf-4bb0-88d7-82eba4338389" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-484888b7-84dd-4946-b4a3-48b66e8236a3" } ], "id": "0d05dd86-7dfb-4c1a-830f-41babeec516e", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0d05dd86-7dfb-4c1a-830f-41babeec516e" }, { "name": "prices", "item": [ { "name": "Retrieve the prices associated to the SKU", "id": "19a16497-1f9f-4e11-b02f-f058618a2faa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/prices", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "prices" ], "variable": [ { "id": "5f6b0467-3ef4-48d2-bcb4-fca689939f10", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the prices associated to the SKU" }, "response": [ { "id": "0b44be22-0aaf-432a-ab07-6b250df53927", "name": "The prices associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/prices", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "prices" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0b44be22-0aaf-432a-ab07-6b250df53927" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19a16497-1f9f-4e11-b02f-f058618a2faa" } ], "id": "77929c2b-8b13-4c6e-8fb9-ddb16e2b5304", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-77929c2b-8b13-4c6e-8fb9-ddb16e2b5304" }, { "name": "stock_items", "item": [ { "name": "Retrieve the stock items associated to the SKU", "id": "977e19a0-20db-4265-9c90-abf5978e5856", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "stock_items" ], "variable": [ { "id": "4d8781e8-1896-433f-922b-32a37c3b7cab", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock items associated to the SKU" }, "response": [ { "id": "56b84746-236d-4d4d-adf3-28c6b364a6a9", "name": "The stock_items associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "stock_items" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-56b84746-236d-4d4d-adf3-28c6b364a6a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-977e19a0-20db-4265-9c90-abf5978e5856" } ], "id": "fb43a03c-f238-4513-a648-a75714149146", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb43a03c-f238-4513-a648-a75714149146" }, { "name": "stock_reservations", "item": [ { "name": "Retrieve the stock reservations associated to the SKU", "id": "cae5f100-7249-4e19-bd8b-aba904ac54ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "stock_reservations" ], "variable": [ { "id": "631a525c-62a9-44c1-83ae-d0c5f3858b01", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservations associated to the SKU" }, "response": [ { "id": "7178ee06-27ac-4675-9fb1-90c824f250bb", "name": "The stock_reservations associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "stock_reservations" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7178ee06-27ac-4675-9fb1-90c824f250bb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cae5f100-7249-4e19-bd8b-aba904ac54ac" } ], "id": "4003bfca-e6e3-4a79-a8bf-d45d8ba3412a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4003bfca-e6e3-4a79-a8bf-d45d8ba3412a" }, { "name": "delivery_lead_times", "item": [ { "name": "Retrieve the delivery lead times associated to the SKU", "id": "3d836f9f-4512-4552-9ff9-4bfbd879a236", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/delivery_lead_times", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "delivery_lead_times" ], "variable": [ { "id": "978cedb2-f8aa-4085-8a7d-4c83c5143abc", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the delivery lead times associated to the SKU" }, "response": [ { "id": "a603dfd7-cfc3-40b4-ab33-b9760e5dfc15", "name": "The delivery_lead_times associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/delivery_lead_times", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "delivery_lead_times" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a603dfd7-cfc3-40b4-ab33-b9760e5dfc15" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3d836f9f-4512-4552-9ff9-4bfbd879a236" } ], "id": "49086692-5b45-4453-8913-685e4ed2b405", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-49086692-5b45-4453-8913-685e4ed2b405" }, { "name": "sku_options", "item": [ { "name": "Retrieve the sku options associated to the SKU", "id": "77ced2d6-fee8-4397-a129-5c158160123d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/sku_options", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "sku_options" ], "variable": [ { "id": "8824f33c-6432-441b-8c3d-e8fb24b70a12", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku options associated to the SKU" }, "response": [ { "id": "dfcd38a2-9a72-496c-8c91-23362aaed092", "name": "The sku_options associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/sku_options", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "sku_options" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dfcd38a2-9a72-496c-8c91-23362aaed092" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-77ced2d6-fee8-4397-a129-5c158160123d" } ], "id": "a77a3682-3a8d-46d9-aef8-7e59997b5dc6", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a77a3682-3a8d-46d9-aef8-7e59997b5dc6" }, { "name": "sku_list_items", "item": [ { "name": "Retrieve the sku list items associated to the SKU", "id": "952efb84-096a-43f5-b884-de79467f74f4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "sku_list_items" ], "variable": [ { "id": "1dab86f7-ef49-4cf8-98f3-5abe91349d45", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku list items associated to the SKU" }, "response": [ { "id": "0789a0c5-1048-41a3-93bc-30546a6d67e7", "name": "The sku_list_items associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/sku_list_items", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "sku_list_items" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0789a0c5-1048-41a3-93bc-30546a6d67e7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-952efb84-096a-43f5-b884-de79467f74f4" } ], "id": "20ef4f83-856c-4c6c-bc84-7efa4a8e4363", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-20ef4f83-856c-4c6c-bc84-7efa4a8e4363" }, { "name": "sku_lists", "item": [ { "name": "Retrieve the sku lists associated to the SKU", "id": "dca80af8-bd50-494e-8a30-4912fc8b4a3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "sku_lists" ], "variable": [ { "id": "1779cbcf-d500-4dc9-b588-52856914b602", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku lists associated to the SKU" }, "response": [ { "id": "775f2bf3-c5c4-481f-b0ac-644030a05cec", "name": "The sku_lists associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/sku_lists", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "sku_lists" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-775f2bf3-c5c4-481f-b0ac-644030a05cec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dca80af8-bd50-494e-8a30-4912fc8b4a3e" } ], "id": "121e3d11-5cb2-4d81-a4cd-52d34a26ab5c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-121e3d11-5cb2-4d81-a4cd-52d34a26ab5c" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the SKU", "id": "c0208ae0-0bd6-4cd3-bd4e-7153fb06131e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "attachments" ], "variable": [ { "id": "23704df6-8786-4a8f-ac40-f7a4448cd98c", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the SKU" }, "response": [ { "id": "05da62f7-2856-467b-beb2-ba586e7c9b01", "name": "The attachments associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "attachments" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-05da62f7-2856-467b-beb2-ba586e7c9b01" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c0208ae0-0bd6-4cd3-bd4e-7153fb06131e" } ], "id": "d7f8752e-3796-440f-89c4-38901d598bdb", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d7f8752e-3796-440f-89c4-38901d598bdb" }, { "name": "links", "item": [ { "name": "Retrieve the links associated to the SKU", "id": "45d0bcd7-a83e-4960-819b-f817cb624499", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/links", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "links" ], "variable": [ { "id": "1789ae06-9354-44ee-a630-8e5204a6e846", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the links associated to the SKU" }, "response": [ { "id": "d1ffa2d1-0228-4358-967c-52da11ba8b29", "name": "The links associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/links", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "links" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d1ffa2d1-0228-4358-967c-52da11ba8b29" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-45d0bcd7-a83e-4960-819b-f817cb624499" } ], "id": "ce424ed0-4471-420f-aa58-a3b3bd300905", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ce424ed0-4471-420f-aa58-a3b3bd300905" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the SKU", "id": "94561a21-ee46-49a1-8d48-2acb288165d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/events", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "events" ], "variable": [ { "id": "011a5ac9-bb6d-4ccc-b242-3385133cfa19", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the SKU" }, "response": [ { "id": "7fccf64a-3f48-405c-8f85-0cd71a487d4c", "name": "The events associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/events", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "events" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7fccf64a-3f48-405c-8f85-0cd71a487d4c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-94561a21-ee46-49a1-8d48-2acb288165d3" } ], "id": "a1cb019f-e0e8-4e0f-b01c-ef4e4d063183", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a1cb019f-e0e8-4e0f-b01c-ef4e4d063183" }, { "name": "tags", "item": [ { "name": "Retrieve the tags associated to the SKU", "id": "95b93573-9140-48e2-87f7-93947e1db6a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/tags", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "tags" ], "variable": [ { "id": "33be5620-251a-4e12-b4c0-bd96827401fd", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tags associated to the SKU" }, "response": [ { "id": "512e5ac1-a773-4984-a050-d764d218e4b1", "name": "The tags associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/tags", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "tags" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-512e5ac1-a773-4984-a050-d764d218e4b1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-95b93573-9140-48e2-87f7-93947e1db6a2" } ], "id": "748d1a17-124a-466c-90e2-95218021f855", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-748d1a17-124a-466c-90e2-95218021f855" }, { "name": "jwt_customer", "item": [ { "name": "Retrieve the jwt customer associated to the SKU", "id": "30379bee-f3fb-4ced-ac15-7e72c65c42e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/jwt_customer", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "jwt_customer" ], "variable": [ { "id": "07ebed1b-0861-4120-9698-e76fab71e74b", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt customer associated to the SKU" }, "response": [ { "id": "02617554-5af8-4680-a223-de2afbe144d4", "name": "The jwt_customer associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/jwt_customer", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "jwt_customer" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-02617554-5af8-4680-a223-de2afbe144d4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-30379bee-f3fb-4ced-ac15-7e72c65c42e0" } ], "id": "505dfce8-8444-40ec-a61e-1f85d20bef0f", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-505dfce8-8444-40ec-a61e-1f85d20bef0f" }, { "name": "jwt_markets", "item": [ { "name": "Retrieve the jwt markets associated to the SKU", "id": "1ecdc8e0-2ca8-49dd-b930-f6068a564e5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/jwt_markets", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "jwt_markets" ], "variable": [ { "id": "6db99456-cd84-45f7-9524-ec9111c7f0c2", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt markets associated to the SKU" }, "response": [ { "id": "39f3458b-f6f3-4f5a-ae4a-92bd744e9e20", "name": "The jwt_markets associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/jwt_markets", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "jwt_markets" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-39f3458b-f6f3-4f5a-ae4a-92bd744e9e20" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ecdc8e0-2ca8-49dd-b930-f6068a564e5a" } ], "id": "ca0deefe-3785-48c0-88c8-4306b6f53d00", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ca0deefe-3785-48c0-88c8-4306b6f53d00" }, { "name": "jwt_stock_locations", "item": [ { "name": "Retrieve the jwt stock locations associated to the SKU", "id": "0ec61b69-abc4-49b3-b964-f8dde47f694f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/jwt_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "jwt_stock_locations" ], "variable": [ { "id": "b81ad647-f314-43f4-8581-e3faa4c48eb8", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the jwt stock locations associated to the SKU" }, "response": [ { "id": "59463a08-87b4-4caf-9c93-7ef0f7be30f0", "name": "The jwt_stock_locations associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/jwt_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "jwt_stock_locations" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-59463a08-87b4-4caf-9c93-7ef0f7be30f0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0ec61b69-abc4-49b3-b964-f8dde47f694f" } ], "id": "d79e3178-c451-4522-bc6b-85f8694ee2f6", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d79e3178-c451-4522-bc6b-85f8694ee2f6" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the SKU", "id": "a3487e8e-16be-4792-adde-fb93ae8fdbe8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "event_stores" ], "variable": [ { "id": "43c18070-61ce-45bb-b6f2-e31fd8bdb985", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the SKU" }, "response": [ { "id": "d2796045-584d-4291-b8f0-52f9e601702e", "name": "The event_stores associated to the SKU", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId", "event_stores" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d2796045-584d-4291-b8f0-52f9e601702e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a3487e8e-16be-4792-adde-fb93ae8fdbe8" } ], "id": "8e01ca72-2a0b-41fd-94d6-fa1e810cd339", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8e01ca72-2a0b-41fd-94d6-fa1e810cd339" }, { "name": "Retrieve a SKU", "id": "6fabedd8-966c-40f3-b2af-5386adb882e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/skus/:skuId", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId" ], "variable": [ { "id": "e39dd556-a2d7-48cc-8f0a-9cbc8e68c8f2", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a SKU" }, "response": [ { "id": "c47bb7ed-67fd-47b0-a329-21fc97b8e8f3", "name": "The SKU object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"skus\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c47bb7ed-67fd-47b0-a329-21fc97b8e8f3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6fabedd8-966c-40f3-b2af-5386adb882e1" }, { "name": "Update a SKU", "id": "a95546c2-3c2c-4e6f-9d63-74acbf82c4f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/skus/:skuId", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId" ], "variable": [ { "id": "0111f1aa-610a-4ca0-8b3b-b96463a77f9e", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a SKU" }, "response": [ { "id": "4a3f6c75-5079-48fa-8cdd-33f8431c50bb", "name": "The updated SKU object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"_add_tags\": \"\",\n \"_remove_tags\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/skus/:skuId", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId" ], "variable": [ { "key": "skuId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"skus\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4a3f6c75-5079-48fa-8cdd-33f8431c50bb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a95546c2-3c2c-4e6f-9d63-74acbf82c4f5" }, { "name": "Delete a SKU", "id": "085d1592-6d65-4268-82a1-6bee021402be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/skus/:skuId", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId" ], "variable": [ { "id": "212e7f68-6428-4fe7-96fa-54cd62869c0e", "key": "skuId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a SKU" }, "response": [ { "id": "353cfb52-574f-49f9-8ff9-89a1a47810c0", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus/:skuId", "host": [ "{{baseUrl}}" ], "path": [ "skus", ":skuId" ], "variable": [ { "key": "skuId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-353cfb52-574f-49f9-8ff9-89a1a47810c0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-085d1592-6d65-4268-82a1-6bee021402be" } ], "id": "d9a0c536-3b04-4828-b4f2-2ccf0a55caee", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9a0c536-3b04-4828-b4f2-2ccf0a55caee" }, { "name": "List all SKUs", "id": "ea3671e0-a6d8-4e60-accd-31ce23637fdd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/skus", "host": [ "{{baseUrl}}" ], "path": [ "skus" ] }, "description": "List all SKUs" }, "response": [ { "id": "c379a907-4c08-438d-a6bf-5749eb4ce767", "name": "A list of SKU objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/skus", "host": [ "{{baseUrl}}" ], "path": [ "skus" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"skus\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"skus\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c379a907-4c08-438d-a6bf-5749eb4ce767" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ea3671e0-a6d8-4e60-accd-31ce23637fdd" }, { "name": "Create a SKU", "id": "d2f7e420-c355-44ab-88b2-d1bab31698a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/skus", "host": [ "{{baseUrl}}" ], "path": [ "skus" ] }, "description": "Create a SKU" }, "response": [ { "id": "a5dd64bf-0fd7-43c4-ae8b-06849d2049a9", "name": "The created SKU object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"skus\",\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"lb\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"data\": {\n \"type\": \"shipping_categories\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/skus", "host": [ "{{baseUrl}}" ], "path": [ "skus" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"skus\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"image_url\": \"\",\n \"pieces_per_pack\": \"\",\n \"weight\": \"\",\n \"unit_of_weight\": \"gr\",\n \"hs_tariff_number\": \"\",\n \"do_not_ship\": \"\",\n \"do_not_track\": \"\",\n \"inventory\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"jwt_custom_claim\": {},\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipping_category\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipping_category\",\n \"id\": \"\"\n }\n },\n \"prices\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"prices\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"delivery_lead_times\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"delivery_lead_times\",\n \"id\": \"\"\n }\n },\n \"sku_options\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_options\",\n \"id\": \"\"\n }\n },\n \"sku_list_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_list_items\",\n \"id\": \"\"\n }\n },\n \"sku_lists\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku_lists\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"links\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"links\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"tags\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\"\n }\n },\n \"jwt_customer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_customer\",\n \"id\": \"\"\n }\n },\n \"jwt_markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_markets\",\n \"id\": \"\"\n }\n },\n \"jwt_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"jwt_stock_locations\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a5dd64bf-0fd7-43c4-ae8b-06849d2049a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d2f7e420-c355-44ab-88b2-d1bab31698a9" } ], "id": "d35d8fbd-fd90-42e4-a395-090eaef91f93", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d35d8fbd-fd90-42e4-a395-090eaef91f93" }, { "name": "stock_items", "item": [ { "name": "{stockItemId}", "item": [ { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the stock item", "id": "ef699602-c210-404c-96e2-38e69c9864f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "stock_location" ], "variable": [ { "id": "b8fcb9b6-da7e-4124-bf7c-7340db9ce485", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the stock item" }, "response": [ { "id": "d75eb95a-2a32-4f15-8e5c-26fdc132d939", "name": "The stock_location associated to the stock item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "stock_location" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d75eb95a-2a32-4f15-8e5c-26fdc132d939" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ef699602-c210-404c-96e2-38e69c9864f3" } ], "id": "1db3d18f-d260-4a29-874e-d212d0688198", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1db3d18f-d260-4a29-874e-d212d0688198" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the stock item", "id": "f93fe4d4-ebc9-4561-8c22-ca621164547f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "sku" ], "variable": [ { "id": "75bc8e2c-863d-416d-860e-4a0a366e4a94", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the stock item" }, "response": [ { "id": "75fc282f-0f05-481a-b6c1-294bee6b2a0d", "name": "The sku associated to the stock item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "sku" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-75fc282f-0f05-481a-b6c1-294bee6b2a0d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f93fe4d4-ebc9-4561-8c22-ca621164547f" } ], "id": "134487e3-04b4-4c64-a9e2-35f83bcfab89", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-134487e3-04b4-4c64-a9e2-35f83bcfab89" }, { "name": "reserved_stock", "item": [ { "name": "Retrieve the reserved stock associated to the stock item", "id": "00b83dda-52aa-4f7d-a580-7a5c17ed51d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/reserved_stock", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "reserved_stock" ], "variable": [ { "id": "004d5897-f149-4b34-8fdf-80908ad4eeb1", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reserved stock associated to the stock item" }, "response": [ { "id": "673841f3-dbc1-46eb-983a-b3d16025a763", "name": "The reserved_stock associated to the stock item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/reserved_stock", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "reserved_stock" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-673841f3-dbc1-46eb-983a-b3d16025a763" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-00b83dda-52aa-4f7d-a580-7a5c17ed51d4" } ], "id": "c1219c18-3caa-478c-9223-f3ea8d8eb998", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c1219c18-3caa-478c-9223-f3ea8d8eb998" }, { "name": "stock_reservations", "item": [ { "name": "Retrieve the stock reservations associated to the stock item", "id": "6dad6b39-02a5-4097-916a-91d0598da301", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "stock_reservations" ], "variable": [ { "id": "33a9828b-abf0-4169-b652-90a94eb17b4b", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservations associated to the stock item" }, "response": [ { "id": "bbe132d3-7abc-42de-aa53-553b6add8e51", "name": "The stock_reservations associated to the stock item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "stock_reservations" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bbe132d3-7abc-42de-aa53-553b6add8e51" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6dad6b39-02a5-4097-916a-91d0598da301" } ], "id": "6c3dcd59-eccf-48d1-b9fa-ae2c1c9594ce", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6c3dcd59-eccf-48d1-b9fa-ae2c1c9594ce" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the stock item", "id": "a59e4e59-cfc7-453a-93d1-5ae64937a417", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "attachments" ], "variable": [ { "id": "f8f80980-a3af-4204-890d-5263c82803fb", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the stock item" }, "response": [ { "id": "4a1be9ae-3508-4fde-b503-e9f1ded6986d", "name": "The attachments associated to the stock item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "attachments" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4a1be9ae-3508-4fde-b503-e9f1ded6986d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a59e4e59-cfc7-453a-93d1-5ae64937a417" } ], "id": "b16fbf45-8d09-47af-9b5b-1588a0ea5014", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b16fbf45-8d09-47af-9b5b-1588a0ea5014" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stock item", "id": "399f5bc3-a3d1-44a6-84fe-d3387f0a06ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "event_stores" ], "variable": [ { "id": "3e30c126-0523-45fe-8edb-3c40e3a4aaa4", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stock item" }, "response": [ { "id": "633657b9-0372-4beb-b5c6-68c74f3c5e32", "name": "The event_stores associated to the stock item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId", "event_stores" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-633657b9-0372-4beb-b5c6-68c74f3c5e32" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-399f5bc3-a3d1-44a6-84fe-d3387f0a06ba" } ], "id": "e0cb9692-2d27-4e3e-ae82-f25eff9e65ca", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e0cb9692-2d27-4e3e-ae82-f25eff9e65ca" }, { "name": "Retrieve a stock item", "id": "ddf71925-3114-458a-aead-0923086c0dc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId" ], "variable": [ { "id": "7275123d-ed7e-46a9-8275-64f6509973cb", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stock item" }, "response": [ { "id": "66daef3d-0c28-499b-95a9-58d6cc7f832a", "name": "The stock item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-66daef3d-0c28-499b-95a9-58d6cc7f832a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ddf71925-3114-458a-aead-0923086c0dc1" }, { "name": "Update a stock item", "id": "6a3472de-44b3-4bba-9327-15af6074b17d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"_validate\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId" ], "variable": [ { "id": "4f3cabb0-6976-45da-9fbe-343122c608b2", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stock item" }, "response": [ { "id": "2f3ef8cf-01b4-4ca1-b554-364926b5acb3", "name": "The updated stock item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"_validate\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2f3ef8cf-01b4-4ca1-b554-364926b5acb3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6a3472de-44b3-4bba-9327-15af6074b17d" }, { "name": "Delete a stock item", "id": "c1b9a2ed-9df9-4d2f-9e0b-0022f5201599", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId" ], "variable": [ { "id": "6f76723d-f334-4858-ba11-30be319926da", "key": "stockItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stock item" }, "response": [ { "id": "0c43306c-b798-469b-b9d4-31a439c54a70", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items/:stockItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_items", ":stockItemId" ], "variable": [ { "key": "stockItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0c43306c-b798-469b-b9d4-31a439c54a70" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c1b9a2ed-9df9-4d2f-9e0b-0022f5201599" } ], "id": "0504a467-f3bf-4f1d-b2c3-247608afe749", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0504a467-f3bf-4f1d-b2c3-247608afe749" }, { "name": "List all stock items", "id": "2861b3d6-f0b8-4394-957a-652e233ac9fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_items" ] }, "description": "List all stock items" }, "response": [ { "id": "c0cf6290-d959-4683-a073-ef1d93f091e0", "name": "A list of stock item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stock_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stock_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c0cf6290-d959-4683-a073-ef1d93f091e0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2861b3d6-f0b8-4394-957a-652e233ac9fe" }, { "name": "Create a stock item", "id": "9fcc2ab6-124c-4abe-9001-8abe75ac1451", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_items" ] }, "description": "Create a stock item" }, "response": [ { "id": "f81b3852-a1e6-4ff4-aef4-438c9ee9c2dc", "name": "The created stock item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"stock_reservations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f81b3852-a1e6-4ff4-aef4-438c9ee9c2dc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9fcc2ab6-124c-4abe-9001-8abe75ac1451" } ], "id": "f7c3a97c-f66c-4ad1-b299-103340a58d72", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f7c3a97c-f66c-4ad1-b299-103340a58d72" }, { "name": "stock_line_items", "item": [ { "name": "{stockLineItemId}", "item": [ { "name": "shipment", "item": [ { "name": "Retrieve the shipment associated to the stock line item", "id": "679cd681-5d46-4e36-9509-38c0e676c58a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "shipment" ], "variable": [ { "id": "e3434cbf-1923-4f8f-b8ff-e6a0ea89d433", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipment associated to the stock line item" }, "response": [ { "id": "18ff1d78-7a3b-45c7-bd5c-bacb13147e11", "name": "The shipment associated to the stock line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "shipment" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-18ff1d78-7a3b-45c7-bd5c-bacb13147e11" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-679cd681-5d46-4e36-9509-38c0e676c58a" } ], "id": "c7a073c4-97b1-49f3-85aa-39a8909b89f6", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c7a073c4-97b1-49f3-85aa-39a8909b89f6" }, { "name": "line_item", "item": [ { "name": "Retrieve the line item associated to the stock line item", "id": "bc4e9e77-4c8e-4149-a3c9-4c5fd7eef3c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "line_item" ], "variable": [ { "id": "5793c6e8-81a7-4492-9a05-d883608c914a", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item associated to the stock line item" }, "response": [ { "id": "3d06efc0-1b1e-4f77-ade0-ebb6f967f540", "name": "The line_item associated to the stock line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "line_item" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d06efc0-1b1e-4f77-ade0-ebb6f967f540" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bc4e9e77-4c8e-4149-a3c9-4c5fd7eef3c7" } ], "id": "0754884d-dc97-4a1c-bc42-74a1448b2cd7", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0754884d-dc97-4a1c-bc42-74a1448b2cd7" }, { "name": "stock_item", "item": [ { "name": "Retrieve the stock item associated to the stock line item", "id": "44fed3c1-5004-4f63-b9ef-56feeb1edfa7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/stock_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "stock_item" ], "variable": [ { "id": "35a0060a-1e20-44b4-8031-5cb94597661b", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock item associated to the stock line item" }, "response": [ { "id": "537bd476-e98d-440a-9b71-06474a443615", "name": "The stock_item associated to the stock line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/stock_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "stock_item" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-537bd476-e98d-440a-9b71-06474a443615" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-44fed3c1-5004-4f63-b9ef-56feeb1edfa7" } ], "id": "a390d11b-d472-4e14-b196-c2586c1afdc3", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a390d11b-d472-4e14-b196-c2586c1afdc3" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the stock line item", "id": "9f04b9ac-c043-456c-88ce-4041676c3480", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "sku" ], "variable": [ { "id": "d83bc7c4-4f68-4621-9962-f4b1efce05fc", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the stock line item" }, "response": [ { "id": "745bef21-aaaa-4f77-a474-3fe2675bf94d", "name": "The sku associated to the stock line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "sku" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-745bef21-aaaa-4f77-a474-3fe2675bf94d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9f04b9ac-c043-456c-88ce-4041676c3480" } ], "id": "f43dcb13-fb86-4aa7-a7ec-8f4ab5fcd416", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f43dcb13-fb86-4aa7-a7ec-8f4ab5fcd416" }, { "name": "stock_reservation", "item": [ { "name": "Retrieve the stock reservation associated to the stock line item", "id": "ca5098d9-3b34-44a8-ae47-20e1efb52855", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/stock_reservation", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "stock_reservation" ], "variable": [ { "id": "f6ff8301-01dd-412f-af60-68beb03c81a0", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservation associated to the stock line item" }, "response": [ { "id": "4b369533-8a42-4cfa-aca1-0a6c5f865fb9", "name": "The stock_reservation associated to the stock line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/stock_reservation", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "stock_reservation" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4b369533-8a42-4cfa-aca1-0a6c5f865fb9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ca5098d9-3b34-44a8-ae47-20e1efb52855" } ], "id": "9fff2269-1dac-4915-9e86-2b1de58aa5d2", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9fff2269-1dac-4915-9e86-2b1de58aa5d2" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stock line item", "id": "6ac1fab0-47c4-4e93-9fd0-44ffd1d7efe0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "event_stores" ], "variable": [ { "id": "8a401c33-11a8-467b-8101-ae87cd879574", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stock line item" }, "response": [ { "id": "918b4b52-13b9-4e98-a30e-136c5de29e83", "name": "The event_stores associated to the stock line item", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId", "event_stores" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-918b4b52-13b9-4e98-a30e-136c5de29e83" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6ac1fab0-47c4-4e93-9fd0-44ffd1d7efe0" } ], "id": "ab708417-bff4-40b7-83fb-24e5cceee5c7", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ab708417-bff4-40b7-83fb-24e5cceee5c7" }, { "name": "Retrieve a stock line item", "id": "037c794b-6dea-4b69-a1bb-9417b81a6c66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId" ], "variable": [ { "id": "cae3155c-b817-41e9-a820-c874fcdfe1e2", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stock line item" }, "response": [ { "id": "0ef9c883-fb88-49e6-aeb1-17460c7abdbf", "name": "The stock line item object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0ef9c883-fb88-49e6-aeb1-17460c7abdbf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-037c794b-6dea-4b69-a1bb-9417b81a6c66" }, { "name": "Update a stock line item", "id": "f2a43981-924f-401d-b77f-0535ce29ea86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"_reserve_stock\": \"\",\n \"_release_stock\": \"\",\n \"_decrement_stock\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId" ], "variable": [ { "id": "9062bcf1-dc65-4f3c-aef4-110e4eaed8fd", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stock line item" }, "response": [ { "id": "00ea9bf8-8167-48bc-b626-bdf0af1b8625", "name": "The updated stock line item object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_line_items\",\n \"id\": \"\",\n \"attributes\": {\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"_reserve_stock\": \"\",\n \"_release_stock\": \"\",\n \"_decrement_stock\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-00ea9bf8-8167-48bc-b626-bdf0af1b8625" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f2a43981-924f-401d-b77f-0535ce29ea86" }, { "name": "Delete a stock line item", "id": "20a5a9ab-19b3-44fc-bc32-3d2e4d2e5b21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId" ], "variable": [ { "id": "96c72bdb-bf95-4977-bca0-fdf79cf33588", "key": "stockLineItemId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stock line item" }, "response": [ { "id": "4c914737-d8a3-4b98-a8c3-bd0b9646ceb6", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items/:stockLineItemId", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items", ":stockLineItemId" ], "variable": [ { "key": "stockLineItemId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4c914737-d8a3-4b98-a8c3-bd0b9646ceb6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-20a5a9ab-19b3-44fc-bc32-3d2e4d2e5b21" } ], "id": "325bd6d8-8945-449b-ace8-d27f910da223", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-325bd6d8-8945-449b-ace8-d27f910da223" }, { "name": "List all stock line items", "id": "907f68ac-e719-4a2b-a866-67c1779feb85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items" ] }, "description": "List all stock line items" }, "response": [ { "id": "3f2e47c1-aabd-4aad-90e1-7b1e41fbc47a", "name": "A list of stock line item objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stock_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stock_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3f2e47c1-aabd-4aad-90e1-7b1e41fbc47a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-907f68ac-e719-4a2b-a866-67c1779feb85" }, { "name": "Create a stock line item", "id": "72897cbc-4da5-481f-a3d6-91acd8e645a1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items" ] }, "description": "Create a stock line item" }, "response": [ { "id": "59f32655-eb3d-4884-a582-608b2adf5e88", "name": "The created stock line item object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_line_items\",\n \"attributes\": {\n \"quantity\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_line_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_line_items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_line_items\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"sku_code\": \"\",\n \"bundle_code\": \"\",\n \"quantity\": \"\",\n \"name\": \"\",\n \"image_url\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-59f32655-eb3d-4884-a582-608b2adf5e88" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-72897cbc-4da5-481f-a3d6-91acd8e645a1" } ], "id": "6cba5d1c-c5f0-430b-998b-ce7382d670cd", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6cba5d1c-c5f0-430b-998b-ce7382d670cd" }, { "name": "stock_locations", "item": [ { "name": "{stockLocationId}", "item": [ { "name": "address", "item": [ { "name": "Retrieve the address associated to the stock location", "id": "2a7aac0f-4476-4c19-853e-5fa7e863cb19", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/address", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "address" ], "variable": [ { "id": "8d024170-92b3-4364-a6a0-7e3f92a1f71b", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the address associated to the stock location" }, "response": [ { "id": "09cbdd2c-022d-492c-8143-010b50dd61a9", "name": "The address associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/address", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "address" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-09cbdd2c-022d-492c-8143-010b50dd61a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2a7aac0f-4476-4c19-853e-5fa7e863cb19" } ], "id": "438df8fc-2ba3-4385-ac8f-4b3d4199e402", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-438df8fc-2ba3-4385-ac8f-4b3d4199e402" }, { "name": "inventory_stock_locations", "item": [ { "name": "Retrieve the inventory stock locations associated to the stock location", "id": "ddcf7352-f911-4a90-a974-c845ca0e3fc8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "inventory_stock_locations" ], "variable": [ { "id": "7baca3c2-175d-4c4b-ade9-642279e7e337", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory stock locations associated to the stock location" }, "response": [ { "id": "748f7218-018d-420f-9188-3e2462f77671", "name": "The inventory_stock_locations associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/inventory_stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "inventory_stock_locations" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-748f7218-018d-420f-9188-3e2462f77671" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ddcf7352-f911-4a90-a974-c845ca0e3fc8" } ], "id": "a7879a10-501b-469f-ada1-20df9e21fd5e", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a7879a10-501b-469f-ada1-20df9e21fd5e" }, { "name": "inventory_return_locations", "item": [ { "name": "Retrieve the inventory return locations associated to the stock location", "id": "5b99ee55-40e3-4e3c-a919-674600e6cd91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "inventory_return_locations" ], "variable": [ { "id": "d5c4b0bd-ffdf-4243-956f-c18aa0223ddf", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the inventory return locations associated to the stock location" }, "response": [ { "id": "0826fe9e-43d5-411f-a89d-6801a3f847bc", "name": "The inventory_return_locations associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/inventory_return_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "inventory_return_locations" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0826fe9e-43d5-411f-a89d-6801a3f847bc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5b99ee55-40e3-4e3c-a919-674600e6cd91" } ], "id": "bfcc079a-1985-4c5f-8f26-abf0f5cfcbf1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bfcc079a-1985-4c5f-8f26-abf0f5cfcbf1" }, { "name": "stock_items", "item": [ { "name": "Retrieve the stock items associated to the stock location", "id": "7831a391-69a0-4488-8a40-1b7118d371fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "stock_items" ], "variable": [ { "id": "38b00ef6-2e8c-47dd-b985-34604cf62e58", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock items associated to the stock location" }, "response": [ { "id": "165c3d89-af46-41f3-8b01-40dce9b8102d", "name": "The stock_items associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/stock_items", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "stock_items" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-165c3d89-af46-41f3-8b01-40dce9b8102d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7831a391-69a0-4488-8a40-1b7118d371fa" } ], "id": "b4ef273e-228b-4d3b-a939-fec5323092f9", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b4ef273e-228b-4d3b-a939-fec5323092f9" }, { "name": "stock_transfers", "item": [ { "name": "Retrieve the stock transfers associated to the stock location", "id": "6deddad5-ca20-46e3-95fc-d970eb803729", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "stock_transfers" ], "variable": [ { "id": "8652a375-aec7-47a3-98fc-95bfc5adb5e5", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock transfers associated to the stock location" }, "response": [ { "id": "b3dd233a-392d-4b70-9a0f-e4269a37eb1d", "name": "The stock_transfers associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "stock_transfers" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b3dd233a-392d-4b70-9a0f-e4269a37eb1d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6deddad5-ca20-46e3-95fc-d970eb803729" } ], "id": "c284044f-2846-43f1-a447-f24abf41ec9b", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c284044f-2846-43f1-a447-f24abf41ec9b" }, { "name": "stores", "item": [ { "name": "Retrieve the stores associated to the stock location", "id": "44e15d7c-0c3a-4c50-82fe-ffdebe1b92e8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "stores" ], "variable": [ { "id": "6e1fa098-b67b-4075-843c-5c6a5be56c04", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stores associated to the stock location" }, "response": [ { "id": "af33391f-2175-43c5-9bd2-d5fed75a905d", "name": "The stores associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "stores" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-af33391f-2175-43c5-9bd2-d5fed75a905d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-44e15d7c-0c3a-4c50-82fe-ffdebe1b92e8" } ], "id": "97bcc7b6-e2cb-4780-bad7-a65f2e51d4bf", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-97bcc7b6-e2cb-4780-bad7-a65f2e51d4bf" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the stock location", "id": "59d3b369-929c-4b57-ada3-7050c6e1e311", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "attachments" ], "variable": [ { "id": "11fc7e68-f82d-4b5d-b221-ad063badd1f3", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the stock location" }, "response": [ { "id": "28a9d308-0716-407c-a75b-ae61356e7da0", "name": "The attachments associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "attachments" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-28a9d308-0716-407c-a75b-ae61356e7da0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-59d3b369-929c-4b57-ada3-7050c6e1e311" } ], "id": "07039449-52f9-422b-af6e-283441a6f8b1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07039449-52f9-422b-af6e-283441a6f8b1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stock location", "id": "3259aba5-0792-4d9e-be04-51da9fc1c727", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "event_stores" ], "variable": [ { "id": "1305a725-290b-48ef-93b2-29b457e9ae18", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stock location" }, "response": [ { "id": "3d6995c1-3e43-45cd-9acf-a004733c7cbc", "name": "The event_stores associated to the stock location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId", "event_stores" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d6995c1-3e43-45cd-9acf-a004733c7cbc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3259aba5-0792-4d9e-be04-51da9fc1c727" } ], "id": "ebf05e8b-3968-4edc-b8ba-7e81d182aebb", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ebf05e8b-3968-4edc-b8ba-7e81d182aebb" }, { "name": "Retrieve a stock location", "id": "c897e537-2872-42ab-82bd-37b2147e73a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId" ], "variable": [ { "id": "d353504c-bd98-4ffc-8024-676123f4b42e", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stock location" }, "response": [ { "id": "5980c452-ce82-40b3-a631-6e7892fdee85", "name": "The stock location object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5980c452-ce82-40b3-a631-6e7892fdee85" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c897e537-2872-42ab-82bd-37b2147e73a8" }, { "name": "Update a stock location", "id": "1ec4e380-2f0a-4d86-9af7-aeb1b816908a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId" ], "variable": [ { "id": "f7c12750-4edd-4854-91e4-d861e78adead", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stock location" }, "response": [ { "id": "38af3fbb-5d58-4800-91d5-1d001bf4e5de", "name": "The updated stock location object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-38af3fbb-5d58-4800-91d5-1d001bf4e5de" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1ec4e380-2f0a-4d86-9af7-aeb1b816908a" }, { "name": "Delete a stock location", "id": "c84a62db-ef44-4769-b687-e80865ff3a13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId" ], "variable": [ { "id": "777a746c-473d-4274-b2e6-c42a740d5514", "key": "stockLocationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stock location" }, "response": [ { "id": "0db5680c-a866-4772-93e6-3c97e9b0f211", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations/:stockLocationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations", ":stockLocationId" ], "variable": [ { "key": "stockLocationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0db5680c-a866-4772-93e6-3c97e9b0f211" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c84a62db-ef44-4769-b687-e80865ff3a13" } ], "id": "86cdb197-b96d-4cbd-8f7a-27a372408216", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-86cdb197-b96d-4cbd-8f7a-27a372408216" }, { "name": "List all stock locations", "id": "2525ab5c-945a-48f5-82df-bc63a3128315", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations" ] }, "description": "List all stock locations" }, "response": [ { "id": "3a639a70-4c0f-46e6-90ba-144f065587c3", "name": "A list of stock location objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3a639a70-4c0f-46e6-90ba-144f065587c3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2525ab5c-945a-48f5-82df-bc63a3128315" }, { "name": "Create a stock location", "id": "29a2cd98-a5ce-411f-9fac-67c49f3ad66c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_locations\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations" ] }, "description": "Create a stock location" }, "response": [ { "id": "c4d24e7e-45a3-46c6-82b3-eca99cc8f512", "name": "The created stock location object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_locations\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"data\": {\n \"type\": \"addresses\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_locations", "host": [ "{{baseUrl}}" ], "path": [ "stock_locations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_locations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"label_format\": \"\",\n \"suppress_etd\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"address\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"address\",\n \"id\": \"\"\n }\n },\n \"inventory_stock_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_stock_locations\",\n \"id\": \"\"\n }\n },\n \"inventory_return_locations\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"inventory_return_locations\",\n \"id\": \"\"\n }\n },\n \"stock_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n },\n \"stock_transfers\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\"\n }\n },\n \"stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c4d24e7e-45a3-46c6-82b3-eca99cc8f512" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-29a2cd98-a5ce-411f-9fac-67c49f3ad66c" } ], "id": "965b36aa-d59c-4c6c-b96c-95492bcdab40", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-965b36aa-d59c-4c6c-b96c-95492bcdab40" }, { "name": "stock_reservations", "item": [ { "name": "{stockReservationId}", "item": [ { "name": "line_item", "item": [ { "name": "Retrieve the line item associated to the stock reservation", "id": "42634bb7-f3eb-4097-9012-2420ae001ae1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "line_item" ], "variable": [ { "id": "ec7313b2-5d75-4002-8130-0a3efadc07ce", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item associated to the stock reservation" }, "response": [ { "id": "27cc6f8b-878c-4323-829c-95197ef052f4", "name": "The line_item associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "line_item" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-27cc6f8b-878c-4323-829c-95197ef052f4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-42634bb7-f3eb-4097-9012-2420ae001ae1" } ], "id": "34e52654-85c4-4414-86f7-10bd867a2b88", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-34e52654-85c4-4414-86f7-10bd867a2b88" }, { "name": "order", "item": [ { "name": "Retrieve the order associated to the stock reservation", "id": "644c1a5b-4cec-4797-bad7-67dd7be6a0c3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/order", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "order" ], "variable": [ { "id": "809df835-fc63-4225-ac25-af1bb19315b1", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the stock reservation" }, "response": [ { "id": "4c50f005-a0c9-43fa-96de-5524db37be7a", "name": "The order associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/order", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "order" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4c50f005-a0c9-43fa-96de-5524db37be7a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-644c1a5b-4cec-4797-bad7-67dd7be6a0c3" } ], "id": "19f27044-d9c0-4882-abcf-9b95d918cf88", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19f27044-d9c0-4882-abcf-9b95d918cf88" }, { "name": "stock_line_item", "item": [ { "name": "Retrieve the stock line item associated to the stock reservation", "id": "eb55adda-4d22-40a2-aa42-395404ecb529", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/stock_line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "stock_line_item" ], "variable": [ { "id": "cfe61596-0914-4099-9953-1922ecc5b2d4", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock line item associated to the stock reservation" }, "response": [ { "id": "624cdecc-cca9-493b-bab3-289a03055ca2", "name": "The stock_line_item associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/stock_line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "stock_line_item" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-624cdecc-cca9-493b-bab3-289a03055ca2" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eb55adda-4d22-40a2-aa42-395404ecb529" } ], "id": "ec50df57-7ca6-4519-98f9-0e1feedcdb90", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ec50df57-7ca6-4519-98f9-0e1feedcdb90" }, { "name": "stock_transfer", "item": [ { "name": "Retrieve the stock transfer associated to the stock reservation", "id": "5def2eb5-553a-405f-bac5-1d7618c340b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/stock_transfer", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "stock_transfer" ], "variable": [ { "id": "51c507ed-2c8d-4423-a23e-014becc40c64", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock transfer associated to the stock reservation" }, "response": [ { "id": "b886ed95-b6c1-488f-8a83-830009397a42", "name": "The stock_transfer associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/stock_transfer", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "stock_transfer" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b886ed95-b6c1-488f-8a83-830009397a42" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5def2eb5-553a-405f-bac5-1d7618c340b2" } ], "id": "ae4d6b94-0d10-4629-9181-4d751ee3c6e1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ae4d6b94-0d10-4629-9181-4d751ee3c6e1" }, { "name": "stock_item", "item": [ { "name": "Retrieve the stock item associated to the stock reservation", "id": "f6e87015-4388-44fc-8a51-55b188a95169", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/stock_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "stock_item" ], "variable": [ { "id": "a3f2f663-b332-428f-a39f-4a633aa5f87d", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock item associated to the stock reservation" }, "response": [ { "id": "abea19d6-32f2-44c8-8585-efd75e884344", "name": "The stock_item associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/stock_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "stock_item" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-abea19d6-32f2-44c8-8585-efd75e884344" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f6e87015-4388-44fc-8a51-55b188a95169" } ], "id": "2d847381-ddcd-418c-9a04-3d4274dadea2", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2d847381-ddcd-418c-9a04-3d4274dadea2" }, { "name": "reserved_stock", "item": [ { "name": "Retrieve the reserved stock associated to the stock reservation", "id": "8ec671a6-1208-42b7-b9e7-d9f84ff808af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/reserved_stock", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "reserved_stock" ], "variable": [ { "id": "f384d9fd-ba65-478f-bc19-c657f9834fc8", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reserved stock associated to the stock reservation" }, "response": [ { "id": "f785ea22-65da-4fac-9f94-defee2ba435a", "name": "The reserved_stock associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/reserved_stock", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "reserved_stock" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f785ea22-65da-4fac-9f94-defee2ba435a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8ec671a6-1208-42b7-b9e7-d9f84ff808af" } ], "id": "c8d0c272-27a9-47f4-a4de-abb2abb5dd6a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c8d0c272-27a9-47f4-a4de-abb2abb5dd6a" }, { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the stock reservation", "id": "c62f674c-7d3b-4a26-9661-f3582f79ebd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "sku" ], "variable": [ { "id": "0f369657-9863-48f4-b5fb-a9e5bdbb8b88", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the stock reservation" }, "response": [ { "id": "6f289318-0187-401b-9972-259a05813d92", "name": "The sku associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "sku" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6f289318-0187-401b-9972-259a05813d92" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c62f674c-7d3b-4a26-9661-f3582f79ebd5" } ], "id": "f3dd8136-b1b2-474c-b02e-70aeef9a658b", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f3dd8136-b1b2-474c-b02e-70aeef9a658b" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stock reservation", "id": "51b053b0-d232-414d-9c35-eaf41199fe29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "event_stores" ], "variable": [ { "id": "62d04e73-004a-4f22-ad26-1bbe92850801", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stock reservation" }, "response": [ { "id": "4cbe1f55-d2b0-4831-aacd-7c96e0b40db3", "name": "The event_stores associated to the stock reservation", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId", "event_stores" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4cbe1f55-d2b0-4831-aacd-7c96e0b40db3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-51b053b0-d232-414d-9c35-eaf41199fe29" } ], "id": "06f50e0e-9e22-4102-8270-69a6755de1dc", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-06f50e0e-9e22-4102-8270-69a6755de1dc" }, { "name": "Retrieve a stock reservation", "id": "5e88a10c-783b-46dc-ad61-534e78e0483a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId" ], "variable": [ { "id": "b3f54fb0-3534-4e4f-9d06-76b8c0dee6f0", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stock reservation" }, "response": [ { "id": "0d396aef-2059-4aeb-bbd2-747c2d5c86da", "name": "The stock reservation object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_reservations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"draft\",\n \"quantity\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"stock_transfer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfer\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0d396aef-2059-4aeb-bbd2-747c2d5c86da" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5e88a10c-783b-46dc-ad61-534e78e0483a" }, { "name": "Update a stock reservation", "id": "cfd442f4-87ac-4012-a640-a4a01bd9fb8d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\",\n \"attributes\": {\n \"quantity\": \"\",\n \"_pending\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId" ], "variable": [ { "id": "bcd321d5-c758-49c7-9e00-9cb7c2653c34", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stock reservation" }, "response": [ { "id": "a5258330-d2a9-474d-9f4d-9dc66ae35af5", "name": "The updated stock reservation object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_reservations\",\n \"id\": \"\",\n \"attributes\": {\n \"quantity\": \"\",\n \"_pending\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_reservations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"draft\",\n \"quantity\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"stock_transfer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfer\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a5258330-d2a9-474d-9f4d-9dc66ae35af5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cfd442f4-87ac-4012-a640-a4a01bd9fb8d" }, { "name": "Delete a stock reservation", "id": "95c573bf-f8ee-4bda-bbcd-227ac14868c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId" ], "variable": [ { "id": "c8d8d797-63b6-4b82-9f5a-eef83da00182", "key": "stockReservationId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stock reservation" }, "response": [ { "id": "3e6b0ca5-c107-4115-a8a3-a66dbb38c5b8", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations/:stockReservationId", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations", ":stockReservationId" ], "variable": [ { "key": "stockReservationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3e6b0ca5-c107-4115-a8a3-a66dbb38c5b8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-95c573bf-f8ee-4bda-bbcd-227ac14868c0" } ], "id": "c0a7b8cb-ada5-47da-87e6-9f7d00f9d9d4", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c0a7b8cb-ada5-47da-87e6-9f7d00f9d9d4" }, { "name": "List all stock reservations", "id": "7ada5e7d-f8de-489e-89a6-68a1d47bf957", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations" ] }, "description": "List all stock reservations" }, "response": [ { "id": "383ceb3d-1c2c-40fe-a6e6-b45c5aca0cf8", "name": "A list of stock reservation objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stock_reservations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"quantity\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"stock_transfer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfer\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stock_reservations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"pending\",\n \"quantity\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"stock_transfer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfer\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-383ceb3d-1c2c-40fe-a6e6-b45c5aca0cf8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7ada5e7d-f8de-489e-89a6-68a1d47bf957" }, { "name": "Create a stock reservation", "id": "4653e602-687d-461c-89b0-8dfd4713adc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_reservations\",\n \"attributes\": {\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_item\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations" ] }, "description": "Create a stock reservation" }, "response": [ { "id": "34fef186-999a-4113-8521-2233bb1ced15", "name": "The created stock reservation object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_reservations\",\n \"attributes\": {\n \"quantity\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"stock_item\": {\n \"data\": {\n \"type\": \"stock_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_reservations", "host": [ "{{baseUrl}}" ], "path": [ "stock_reservations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_reservations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"status\": \"draft\",\n \"quantity\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"stock_line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_line_item\",\n \"id\": \"\"\n }\n },\n \"stock_transfer\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_transfer\",\n \"id\": \"\"\n }\n },\n \"stock_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_item\",\n \"id\": \"\"\n }\n },\n \"reserved_stock\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reserved_stock\",\n \"id\": \"\"\n }\n },\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-34fef186-999a-4113-8521-2233bb1ced15" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4653e602-687d-461c-89b0-8dfd4713adc1" } ], "id": "b52c5bf1-bd53-4f4f-8d51-25384df19fe8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b52c5bf1-bd53-4f4f-8d51-25384df19fe8" }, { "name": "stock_transfers", "item": [ { "name": "{stockTransferId}", "item": [ { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the stock transfer", "id": "d42766c8-a92f-4786-ab8a-2907a0716eb3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "sku" ], "variable": [ { "id": "324dfe6d-b2a0-47c5-9730-9c055677ba08", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the stock transfer" }, "response": [ { "id": "85d978a1-9d52-4c01-83d3-22e472cf88c6", "name": "The sku associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/sku", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "sku" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-85d978a1-9d52-4c01-83d3-22e472cf88c6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d42766c8-a92f-4786-ab8a-2907a0716eb3" } ], "id": "b9335516-98ed-48e2-8e66-c491ea5c6fe8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b9335516-98ed-48e2-8e66-c491ea5c6fe8" }, { "name": "origin_stock_location", "item": [ { "name": "Retrieve the origin stock location associated to the stock transfer", "id": "5b15d7d4-526c-461a-b132-1689c7960d4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/origin_stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "origin_stock_location" ], "variable": [ { "id": "1bcf6bbd-fe85-4c34-b1c3-3f96069c697e", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the origin stock location associated to the stock transfer" }, "response": [ { "id": "d798933d-fc07-42be-82b1-59bb879ac796", "name": "The origin_stock_location associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/origin_stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "origin_stock_location" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d798933d-fc07-42be-82b1-59bb879ac796" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5b15d7d4-526c-461a-b132-1689c7960d4f" } ], "id": "6560aa50-6533-4105-b61c-6e2bc46e1136", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6560aa50-6533-4105-b61c-6e2bc46e1136" }, { "name": "destination_stock_location", "item": [ { "name": "Retrieve the destination stock location associated to the stock transfer", "id": "3bb25ca1-6191-48ef-a9cb-418dd433e4ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/destination_stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "destination_stock_location" ], "variable": [ { "id": "c9b77d51-46d8-4aa7-815f-61a72d266920", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the destination stock location associated to the stock transfer" }, "response": [ { "id": "ed3e2aa6-3a27-40c1-a4da-3d386e094854", "name": "The destination_stock_location associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/destination_stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "destination_stock_location" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ed3e2aa6-3a27-40c1-a4da-3d386e094854" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3bb25ca1-6191-48ef-a9cb-418dd433e4ee" } ], "id": "1be29ae2-60f3-448b-a302-1a3140f8a6b7", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1be29ae2-60f3-448b-a302-1a3140f8a6b7" }, { "name": "shipment", "item": [ { "name": "Retrieve the shipment associated to the stock transfer", "id": "55c64848-9fdd-4481-bd83-adc0ff8fb257", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "shipment" ], "variable": [ { "id": "57df75e5-a18e-46ae-9528-05d702b3c35c", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the shipment associated to the stock transfer" }, "response": [ { "id": "b335ba5a-2d1f-47ab-817d-9583c6427b4f", "name": "The shipment associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/shipment", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "shipment" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b335ba5a-2d1f-47ab-817d-9583c6427b4f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-55c64848-9fdd-4481-bd83-adc0ff8fb257" } ], "id": "a39a8387-65f0-4ef2-9b57-de9d007ae780", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a39a8387-65f0-4ef2-9b57-de9d007ae780" }, { "name": "line_item", "item": [ { "name": "Retrieve the line item associated to the stock transfer", "id": "4c4dc9b5-c4d4-4eb7-9c90-c27db8f37512", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "line_item" ], "variable": [ { "id": "8c505052-f54b-485f-9d2b-ce247842c37d", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the line item associated to the stock transfer" }, "response": [ { "id": "fce9f132-498e-42e9-98fe-3af2350cfa45", "name": "The line_item associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/line_item", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "line_item" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fce9f132-498e-42e9-98fe-3af2350cfa45" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4c4dc9b5-c4d4-4eb7-9c90-c27db8f37512" } ], "id": "a06c1e85-62fa-41bf-8ba0-588f6151e575", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a06c1e85-62fa-41bf-8ba0-588f6151e575" }, { "name": "stock_reservation", "item": [ { "name": "Retrieve the stock reservation associated to the stock transfer", "id": "3bae71d8-6c79-4caf-983b-1f87753927cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/stock_reservation", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "stock_reservation" ], "variable": [ { "id": "cfe95e1c-2a64-45c2-9a32-ef04338d601e", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock reservation associated to the stock transfer" }, "response": [ { "id": "dec43f99-0262-4a89-8835-f95dbf7e5def", "name": "The stock_reservation associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/stock_reservation", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "stock_reservation" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dec43f99-0262-4a89-8835-f95dbf7e5def" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3bae71d8-6c79-4caf-983b-1f87753927cc" } ], "id": "e87397fc-f4bd-43a6-a5d4-9e94dcafe0d1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e87397fc-f4bd-43a6-a5d4-9e94dcafe0d1" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the stock transfer", "id": "c6ce7c90-d9fb-46d8-ad97-8bafddcb590b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "attachments" ], "variable": [ { "id": "1203ab22-1996-4ead-abf1-1726e413d44e", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the stock transfer" }, "response": [ { "id": "fa23db59-82b1-488e-b54d-5ec7b2dd0135", "name": "The attachments associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "attachments" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa23db59-82b1-488e-b54d-5ec7b2dd0135" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c6ce7c90-d9fb-46d8-ad97-8bafddcb590b" } ], "id": "41fc2aa5-372a-4c87-93cb-502c39de2fb8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-41fc2aa5-372a-4c87-93cb-502c39de2fb8" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the stock transfer", "id": "7f50ea9e-9e53-4512-81b6-bfc3eef0fe54", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/events", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "events" ], "variable": [ { "id": "5c459e93-70cd-4b42-81d1-c28372431bf6", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the stock transfer" }, "response": [ { "id": "003977bb-8af7-4853-93fb-48ee40a89c26", "name": "The events associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/events", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "events" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-003977bb-8af7-4853-93fb-48ee40a89c26" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7f50ea9e-9e53-4512-81b6-bfc3eef0fe54" } ], "id": "3925536e-5afd-4118-8b92-861389c9f7b5", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3925536e-5afd-4118-8b92-861389c9f7b5" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stock transfer", "id": "48b2176b-8681-4019-8f34-de8aa494265b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "event_stores" ], "variable": [ { "id": "2bebcc70-5176-4896-b713-b7019f02dec1", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stock transfer" }, "response": [ { "id": "32ec339e-2bc5-4c7a-82c4-c6f384d0f552", "name": "The event_stores associated to the stock transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId", "event_stores" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-32ec339e-2bc5-4c7a-82c4-c6f384d0f552" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-48b2176b-8681-4019-8f34-de8aa494265b" } ], "id": "ff827eb7-2d0a-4647-95d6-0ab1ed31e60c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ff827eb7-2d0a-4647-95d6-0ab1ed31e60c" }, { "name": "Retrieve a stock transfer", "id": "0863117d-6794-4ae6-b4f3-28b92df820c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId" ], "variable": [ { "id": "62564c0b-134b-4672-ba3c-39887d169679", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stock transfer" }, "response": [ { "id": "4bc2c92d-78f9-44e0-8450-32dce0dd1df9", "name": "The stock transfer object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"status\": \"picking\",\n \"quantity\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"in_transit_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_stock_location\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_stock_location\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4bc2c92d-78f9-44e0-8450-32dce0dd1df9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0863117d-6794-4ae6-b4f3-28b92df820c1" }, { "name": "Update a stock transfer", "id": "26d0b1c0-cc8d-437e-aea0-6b6a0484f4d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\",\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"_upcoming\": \"\",\n \"_on_hold\": \"\",\n \"_picking\": \"\",\n \"_in_transit\": \"\",\n \"_complete\": \"\",\n \"_cancel\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId" ], "variable": [ { "id": "4b19b290-edc9-4b28-bb7d-566738e67e67", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stock transfer" }, "response": [ { "id": "f8711e01-fb61-4abd-a4f3-2c0aa36a07c4", "name": "The updated stock transfer object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_transfers\",\n \"id\": \"\",\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"quantity\": \"\",\n \"_upcoming\": \"\",\n \"_on_hold\": \"\",\n \"_picking\": \"\",\n \"_in_transit\": \"\",\n \"_complete\": \"\",\n \"_cancel\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"status\": \"picking\",\n \"quantity\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"in_transit_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_stock_location\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_stock_location\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f8711e01-fb61-4abd-a4f3-2c0aa36a07c4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-26d0b1c0-cc8d-437e-aea0-6b6a0484f4d1" }, { "name": "Delete a stock transfer", "id": "1d4299d7-f931-4a18-88ef-bbe72233b12e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId" ], "variable": [ { "id": "e1fe55fc-77b9-408f-a688-d8354f5d13f7", "key": "stockTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stock transfer" }, "response": [ { "id": "a8d7b4a8-bb85-41c2-a714-ce3557c46f30", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers/:stockTransferId", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers", ":stockTransferId" ], "variable": [ { "key": "stockTransferId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a8d7b4a8-bb85-41c2-a714-ce3557c46f30" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1d4299d7-f931-4a18-88ef-bbe72233b12e" } ], "id": "34507c01-3c08-45cc-b4b9-4387e3523f5c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-34507c01-3c08-45cc-b4b9-4387e3523f5c" }, { "name": "List all stock transfers", "id": "c48c820c-3f6c-4147-a87a-251cbd6793ef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers" ] }, "description": "List all stock transfers" }, "response": [ { "id": "bc8c4c32-4b79-49e3-9245-551276ccaf57", "name": "A list of stock transfer objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stock_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"status\": \"upcoming\",\n \"quantity\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"in_transit_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_stock_location\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_stock_location\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stock_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"status\": \"completed\",\n \"quantity\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"in_transit_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_stock_location\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_stock_location\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-bc8c4c32-4b79-49e3-9245-551276ccaf57" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c48c820c-3f6c-4147-a87a-251cbd6793ef" }, { "name": "Create a stock transfer", "id": "113fb673-94ad-42d5-a65b-fd73d2a1440e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_transfers\",\n \"attributes\": {\n \"quantity\": \"\",\n \"number\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers" ] }, "description": "Create a stock transfer" }, "response": [ { "id": "cc65b0ba-50cf-4cc9-ad2f-c7e803882a39", "name": "The created stock transfer object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stock_transfers\",\n \"attributes\": {\n \"quantity\": \"\",\n \"number\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"data\": {\n \"type\": \"shipments\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"data\": {\n \"type\": \"line_items\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stock_transfers", "host": [ "{{baseUrl}}" ], "path": [ "stock_transfers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stock_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"sku_code\": \"\",\n \"status\": \"picking\",\n \"quantity\": \"\",\n \"on_hold_at\": \"\",\n \"picking_at\": \"\",\n \"in_transit_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"origin_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"origin_stock_location\",\n \"id\": \"\"\n }\n },\n \"destination_stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"destination_stock_location\",\n \"id\": \"\"\n }\n },\n \"shipment\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"shipment\",\n \"id\": \"\"\n }\n },\n \"line_item\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"line_item\",\n \"id\": \"\"\n }\n },\n \"stock_reservation\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_reservation\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cc65b0ba-50cf-4cc9-ad2f-c7e803882a39" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-113fb673-94ad-42d5-a65b-fd73d2a1440e" } ], "id": "bc04d438-6f2c-462f-8c12-a63359d97b1d", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bc04d438-6f2c-462f-8c12-a63359d97b1d" }, { "name": "stores", "item": [ { "name": "{storeId}", "item": [ { "name": "market", "item": [ { "name": "Retrieve the market associated to the store", "id": "afb28c4f-7192-436f-8559-79aa3eaa2edf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/market", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "market" ], "variable": [ { "id": "31985c31-f41b-4027-8338-3ebdaa202346", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the market associated to the store" }, "response": [ { "id": "38882ff8-67f9-4908-a85d-6a049c8598bf", "name": "The market associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/market", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "market" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-38882ff8-67f9-4908-a85d-6a049c8598bf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-afb28c4f-7192-436f-8559-79aa3eaa2edf" } ], "id": "681b606f-48a8-44b2-8701-ee00fe5cf806", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-681b606f-48a8-44b2-8701-ee00fe5cf806" }, { "name": "merchant", "item": [ { "name": "Retrieve the merchant associated to the store", "id": "f5842132-cb24-4528-84c1-a6a024353294", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/merchant", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "merchant" ], "variable": [ { "id": "5a2e1184-2a4f-4d6a-8503-805ab5b42811", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the merchant associated to the store" }, "response": [ { "id": "6ad85490-93e2-43f7-b0fd-eb71e55e2f36", "name": "The merchant associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/merchant", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "merchant" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6ad85490-93e2-43f7-b0fd-eb71e55e2f36" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f5842132-cb24-4528-84c1-a6a024353294" } ], "id": "5bfda9d2-d254-466c-b72f-58f0a3fa32c7", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5bfda9d2-d254-466c-b72f-58f0a3fa32c7" }, { "name": "stock_location", "item": [ { "name": "Retrieve the stock location associated to the store", "id": "4f2d3fd7-c271-4d22-941e-d4b27471f7d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "stock_location" ], "variable": [ { "id": "6ddf4621-34d4-4b0b-b3f6-7019c8ffc26c", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stock location associated to the store" }, "response": [ { "id": "fc6dfcfd-e0cc-47a2-8452-6bc4c6cf66c9", "name": "The stock_location associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/stock_location", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "stock_location" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fc6dfcfd-e0cc-47a2-8452-6bc4c6cf66c9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4f2d3fd7-c271-4d22-941e-d4b27471f7d9" } ], "id": "bce2aa1b-603c-4146-a064-885e12a729a0", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bce2aa1b-603c-4146-a064-885e12a729a0" }, { "name": "orders", "item": [ { "name": "Retrieve the orders associated to the store", "id": "f693356a-fe00-44f3-a631-d1a41af0ef68", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/orders", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "orders" ], "variable": [ { "id": "0145dd0f-02e9-4e3d-8da2-43e5386b664e", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the orders associated to the store" }, "response": [ { "id": "c5dad4cc-fa72-4d10-a730-1cd1fce5def1", "name": "The orders associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/orders", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "orders" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c5dad4cc-fa72-4d10-a730-1cd1fce5def1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f693356a-fe00-44f3-a631-d1a41af0ef68" } ], "id": "93f31017-9719-452c-b670-6670a544aee0", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-93f31017-9719-452c-b670-6670a544aee0" }, { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the store", "id": "dbd90d1e-09a7-4a98-adbf-c26ddb09ef25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "payment_methods" ], "variable": [ { "id": "26f5acc3-0272-4669-a783-0df6764e4645", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the store" }, "response": [ { "id": "9383ebc9-e582-4530-9151-d1110fa25c59", "name": "The payment_methods associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "payment_methods" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9383ebc9-e582-4530-9151-d1110fa25c59" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dbd90d1e-09a7-4a98-adbf-c26ddb09ef25" } ], "id": "dc101e4f-e970-4b70-8fb9-15fcc9225e01", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dc101e4f-e970-4b70-8fb9-15fcc9225e01" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the store", "id": "d57591c3-4a0d-4ce7-931f-e27597798de5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/events", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "events" ], "variable": [ { "id": "2504738e-3b27-4d41-9ce5-6dd4952ca6ab", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the store" }, "response": [ { "id": "49fd1880-f25c-4eba-84a0-55aaf09d1e5b", "name": "The events associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/events", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "events" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-49fd1880-f25c-4eba-84a0-55aaf09d1e5b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d57591c3-4a0d-4ce7-931f-e27597798de5" } ], "id": "c9a28311-649e-467b-81df-f4350e6f4435", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c9a28311-649e-467b-81df-f4350e6f4435" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the store", "id": "0c53e8c6-f661-4fa6-843b-3a01575923e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "event_stores" ], "variable": [ { "id": "6b0aef64-7437-45d9-90e1-2daba63cf5b4", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the store" }, "response": [ { "id": "e652eb7b-a1e8-4eb5-9a7d-913f8cefb4a5", "name": "The event_stores associated to the store", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId", "event_stores" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e652eb7b-a1e8-4eb5-9a7d-913f8cefb4a5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0c53e8c6-f661-4fa6-843b-3a01575923e4" } ], "id": "e551ce26-2eca-403b-a77b-90054cf7dac7", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e551ce26-2eca-403b-a77b-90054cf7dac7" }, { "name": "Retrieve a store", "id": "12f91d18-1ab8-4b05-a4ab-28c0c1d15568", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId" ], "variable": [ { "id": "87d8a7c9-3d16-4246-b767-d44ecb895109", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a store" }, "response": [ { "id": "1201eca7-142b-47de-9bba-ffda8c1ada99", "name": "The store object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stores\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1201eca7-142b-47de-9bba-ffda8c1ada99" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-12f91d18-1ab8-4b05-a4ab-28c0c1d15568" }, { "name": "Update a store", "id": "eddb984b-6471-48eb-aed4-6daeea3bbce6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId" ], "variable": [ { "id": "dec26e73-8ae7-4426-aa60-7dc943f95ae3", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a store" }, "response": [ { "id": "3d058de2-1e43-475f-a068-e3bd9a4f534b", "name": "The updated store object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stores\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId" ], "variable": [ { "key": "storeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stores\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d058de2-1e43-475f-a068-e3bd9a4f534b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eddb984b-6471-48eb-aed4-6daeea3bbce6" }, { "name": "Delete a store", "id": "bcb21546-575e-44ae-b63e-54f08015ce68", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId" ], "variable": [ { "id": "92c2938c-ed73-4b0d-b058-306d564ba87d", "key": "storeId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a store" }, "response": [ { "id": "273163bc-b30e-4476-9ab3-120669215fcb", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores/:storeId", "host": [ "{{baseUrl}}" ], "path": [ "stores", ":storeId" ], "variable": [ { "key": "storeId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-273163bc-b30e-4476-9ab3-120669215fcb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bcb21546-575e-44ae-b63e-54f08015ce68" } ], "id": "ebdec685-ec06-4445-b075-20c4236f9a75", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ebdec685-ec06-4445-b075-20c4236f9a75" }, { "name": "List all stores", "id": "f0ea5b33-da4f-4386-a259-b9ad738d6e47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stores", "host": [ "{{baseUrl}}" ], "path": [ "stores" ] }, "description": "List all stores" }, "response": [ { "id": "2d159f48-6d80-4ac8-9ec4-1640a3114998", "name": "A list of store objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stores", "host": [ "{{baseUrl}}" ], "path": [ "stores" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stores\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stores\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2d159f48-6d80-4ac8-9ec4-1640a3114998" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f0ea5b33-da4f-4386-a259-b9ad738d6e47" }, { "name": "Create a store", "id": "36a84d3b-ba20-4ec9-ba79-ab0769f1b5bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stores", "host": [ "{{baseUrl}}" ], "path": [ "stores" ] }, "description": "Create a store" }, "response": [ { "id": "4e51e0c5-4284-4bbb-9c24-dbe57aeab49e", "name": "The created store object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stores\",\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"data\": {\n \"type\": \"merchants\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"data\": {\n \"type\": \"stock_locations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stores", "host": [ "{{baseUrl}}" ], "path": [ "stores" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stores\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"market\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"market\",\n \"id\": \"\"\n }\n },\n \"merchant\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"merchant\",\n \"id\": \"\"\n }\n },\n \"stock_location\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stock_location\",\n \"id\": \"\"\n }\n },\n \"orders\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n },\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4e51e0c5-4284-4bbb-9c24-dbe57aeab49e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-36a84d3b-ba20-4ec9-ba79-ab0769f1b5bd" } ], "id": "4d604d4b-20a5-44e9-b175-238d40a88d26", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4d604d4b-20a5-44e9-b175-238d40a88d26" }, { "name": "stripe_gateways", "item": [ { "name": "{stripeGatewayId}", "item": [ { "name": "payment_methods", "item": [ { "name": "Retrieve the payment methods associated to the stripe gateway", "id": "a8c16f59-2afe-4b4a-ae3a-97fe2709733c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId", "payment_methods" ], "variable": [ { "id": "c4bcc890-76c8-4a9e-9249-eadca8da9213", "key": "stripeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment methods associated to the stripe gateway" }, "response": [ { "id": "a4402786-97eb-4c8a-b3ef-88841d25d599", "name": "The payment_methods associated to the stripe gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId/payment_methods", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId", "payment_methods" ], "variable": [ { "key": "stripeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a4402786-97eb-4c8a-b3ef-88841d25d599" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8c16f59-2afe-4b4a-ae3a-97fe2709733c" } ], "id": "3dfbc871-e7d3-4fdb-9256-7d2375cdceac", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3dfbc871-e7d3-4fdb-9256-7d2375cdceac" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stripe gateway", "id": "2549ead7-c7ab-4220-ac8c-3061a7ce905c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId", "event_stores" ], "variable": [ { "id": "25035466-4d70-40ce-99c7-03b27741a2bb", "key": "stripeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stripe gateway" }, "response": [ { "id": "2089693f-53b3-45db-8441-abfe09ef8ce3", "name": "The event_stores associated to the stripe gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId", "event_stores" ], "variable": [ { "key": "stripeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-2089693f-53b3-45db-8441-abfe09ef8ce3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2549ead7-c7ab-4220-ac8c-3061a7ce905c" } ], "id": "eef67d1b-9613-4611-85ab-0d56f9be3ec4", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eef67d1b-9613-4611-85ab-0d56f9be3ec4" }, { "name": "stripe_payments", "item": [ { "name": "Retrieve the stripe payments associated to the stripe gateway", "id": "afb1741f-9226-4d15-966c-c163302e8777", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId/stripe_payments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId", "stripe_payments" ], "variable": [ { "id": "071df28d-e263-4aff-a580-43687d3574a3", "key": "stripeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the stripe payments associated to the stripe gateway" }, "response": [ { "id": "32af859f-7c9c-431c-a988-b46c6dc1e3f4", "name": "The stripe_payments associated to the stripe gateway", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId/stripe_payments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId", "stripe_payments" ], "variable": [ { "key": "stripeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-32af859f-7c9c-431c-a988-b46c6dc1e3f4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-afb1741f-9226-4d15-966c-c163302e8777" } ], "id": "722c8cae-2464-4c7f-a7be-5f0e5c945d24", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-722c8cae-2464-4c7f-a7be-5f0e5c945d24" }, { "name": "Retrieve a stripe gateway", "id": "fb91d3e2-9190-4e91-9d46-28344b9b8cc9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId" ], "variable": [ { "id": "acbbdc95-f68f-484b-9d98-c451fd57b5b9", "key": "stripeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stripe gateway" }, "response": [ { "id": "20f5b46f-53d2-4357-9aed-0fd799076f7e", "name": "The stripe gateway object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId" ], "variable": [ { "key": "stripeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"connected_account\": \"\",\n \"auto_payments\": \"\",\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"stripe_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-20f5b46f-53d2-4357-9aed-0fd799076f7e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fb91d3e2-9190-4e91-9d46-28344b9b8cc9" }, { "name": "Update a stripe gateway", "id": "ed7d631e-bc15-49de-8b32-497140e46153", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"connected_account\": \"\",\n \"auto_payments\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId" ], "variable": [ { "id": "ee89d1a5-a6e6-46f4-bb2f-12e753c2f995", "key": "stripeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stripe gateway" }, "response": [ { "id": "0a81f880-0365-49da-97e5-5eebb561d7ac", "name": "The updated stripe gateway object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_gateways\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"connected_account\": \"\",\n \"auto_payments\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId" ], "variable": [ { "key": "stripeGatewayId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"connected_account\": \"\",\n \"auto_payments\": \"\",\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"stripe_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0a81f880-0365-49da-97e5-5eebb561d7ac" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ed7d631e-bc15-49de-8b32-497140e46153" }, { "name": "Delete a stripe gateway", "id": "e1529e19-876c-468f-94c4-e58fdc708132", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId" ], "variable": [ { "id": "5e7dc623-23f7-452d-a395-c682442ae919", "key": "stripeGatewayId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stripe gateway" }, "response": [ { "id": "3b4178ce-04fd-437a-92db-3c12dcd535c9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_gateways/:stripeGatewayId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways", ":stripeGatewayId" ], "variable": [ { "key": "stripeGatewayId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3b4178ce-04fd-437a-92db-3c12dcd535c9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e1529e19-876c-468f-94c4-e58fdc708132" } ], "id": "d2a2f400-1ccc-4d9d-b3a7-0d15426fc6cf", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d2a2f400-1ccc-4d9d-b3a7-0d15426fc6cf" }, { "name": "List all stripe gateways", "id": "16180a3c-2ca0-4d56-a2f8-6f2533a741f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stripe_gateways", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways" ] }, "description": "List all stripe gateways" }, "response": [ { "id": "ef387a35-4fba-4b4f-8de6-2f1a8367a1d6", "name": "A list of stripe gateway objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_gateways", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stripe_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"connected_account\": \"\",\n \"auto_payments\": \"\",\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"stripe_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stripe_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"connected_account\": \"\",\n \"auto_payments\": \"\",\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"stripe_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ef387a35-4fba-4b4f-8de6-2f1a8367a1d6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-16180a3c-2ca0-4d56-a2f8-6f2533a741f3" }, { "name": "Create a stripe gateway", "id": "53f6b208-d371-470e-be33-b5fdbe9a754b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"login\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"publishable_key\": \"\",\n \"connected_account\": \"\",\n \"auto_payments\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_gateways", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways" ] }, "description": "Create a stripe gateway" }, "response": [ { "id": "9a8eb6e4-40c2-4062-a47a-1c9eec4d82c5", "name": "The created stripe gateway object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_gateways\",\n \"attributes\": {\n \"name\": \"\",\n \"login\": \"\",\n \"force_payments\": \"\",\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_check\": \"\",\n \"publishable_key\": \"\",\n \"connected_account\": \"\",\n \"auto_payments\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_gateways", "host": [ "{{baseUrl}}" ], "path": [ "stripe_gateways" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_gateways\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"force_payments\": \"\",\n \"credential_keys\": {},\n \"disabled_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"connected_account\": \"\",\n \"auto_payments\": \"\",\n \"webhook_endpoint_id\": \"\",\n \"webhook_endpoint_secret\": \"\",\n \"webhook_endpoint_url\": \"\"\n },\n \"relationships\": {\n \"payment_methods\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_methods\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"stripe_payments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9a8eb6e4-40c2-4062-a47a-1c9eec4d82c5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-53f6b208-d371-470e-be33-b5fdbe9a754b" } ], "id": "a1247580-5a4b-4c24-aa22-3e0d415dc33b", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a1247580-5a4b-4c24-aa22-3e0d415dc33b" }, { "name": "stripe_payments", "item": [ { "name": "{stripePaymentId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the stripe payment", "id": "edde5ff9-b46f-4a04-9d37-f4c9ed957164", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId", "order" ], "variable": [ { "id": "0bd79c36-ce07-4b01-8aac-44cc514734e9", "key": "stripePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the stripe payment" }, "response": [ { "id": "a2bbd069-a7a8-4774-9567-dad21af382a1", "name": "The order associated to the stripe payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId/order", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId", "order" ], "variable": [ { "key": "stripePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a2bbd069-a7a8-4774-9567-dad21af382a1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-edde5ff9-b46f-4a04-9d37-f4c9ed957164" } ], "id": "d45e3563-8942-443a-b2d3-9fc30fd3cc50", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d45e3563-8942-443a-b2d3-9fc30fd3cc50" }, { "name": "payment_gateway", "item": [ { "name": "Retrieve the payment gateway associated to the stripe payment", "id": "22cad06e-8d7c-4236-b519-13be41e76990", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId", "payment_gateway" ], "variable": [ { "id": "84e9782d-79f5-46b3-bde4-368f4a33e980", "key": "stripePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the payment gateway associated to the stripe payment" }, "response": [ { "id": "ff6df244-0450-4c2f-a3df-7180a4c173fa", "name": "The payment_gateway associated to the stripe payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId/payment_gateway", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId", "payment_gateway" ], "variable": [ { "key": "stripePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ff6df244-0450-4c2f-a3df-7180a4c173fa" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-22cad06e-8d7c-4236-b519-13be41e76990" } ], "id": "d08a2e86-c54c-465f-b273-0b24b9eab3e6", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d08a2e86-c54c-465f-b273-0b24b9eab3e6" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stripe payment", "id": "541a2868-0c8e-4f97-b651-097659ba628f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId", "event_stores" ], "variable": [ { "id": "044bc14a-8ccb-4647-9247-bcdcb6369080", "key": "stripePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stripe payment" }, "response": [ { "id": "9b327754-7310-41a0-ad2f-5bd94a91384f", "name": "The event_stores associated to the stripe payment", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId", "event_stores" ], "variable": [ { "key": "stripePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9b327754-7310-41a0-ad2f-5bd94a91384f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-541a2868-0c8e-4f97-b651-097659ba628f" } ], "id": "22f1ed9c-6d47-4197-ba0d-d5b66b4c8a35", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-22f1ed9c-6d47-4197-ba0d-d5b66b4c8a35" }, { "name": "Retrieve a stripe payment", "id": "c54a1fb8-7cc5-4ed2-b967-e03f6446bd7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId" ], "variable": [ { "id": "63a4e01c-1f51-4318-90a6-e836f4579c57", "key": "stripePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stripe payment" }, "response": [ { "id": "5291430a-8f32-43b6-9953-ad5c48e81f59", "name": "The stripe payment object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId" ], "variable": [ { "key": "stripePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"connected_account\": \"\",\n \"charge_id\": \"\",\n \"publishable_key\": \"\",\n \"on_behalf_of\": \"\",\n \"transfer_group\": \"\",\n \"options\": {},\n \"payment_method\": {},\n \"mismatched_amounts\": \"\",\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5291430a-8f32-43b6-9953-ad5c48e81f59" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c54a1fb8-7cc5-4ed2-b967-e03f6446bd7a" }, { "name": "Update a stripe payment", "id": "70f333f6-87e4-4ff3-89e5-e6e7256428b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"options\": {},\n \"return_url\": \"\",\n \"_update\": \"\",\n \"_refresh\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId" ], "variable": [ { "id": "c2821c5e-915a-4b8a-8690-f7c3e9b507ea", "key": "stripePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stripe payment" }, "response": [ { "id": "3d49911f-91fc-4873-ad99-705744c08f96", "name": "The updated stripe payment object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_payments\",\n \"id\": \"\",\n \"attributes\": {\n \"options\": {},\n \"return_url\": \"\",\n \"_update\": \"\",\n \"_refresh\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId" ], "variable": [ { "key": "stripePaymentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"connected_account\": \"\",\n \"charge_id\": \"\",\n \"publishable_key\": \"\",\n \"on_behalf_of\": \"\",\n \"transfer_group\": \"\",\n \"options\": {},\n \"payment_method\": {},\n \"mismatched_amounts\": \"\",\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3d49911f-91fc-4873-ad99-705744c08f96" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-70f333f6-87e4-4ff3-89e5-e6e7256428b3" }, { "name": "Delete a stripe payment", "id": "97160e81-9090-4660-af10-3dab5a283597", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId" ], "variable": [ { "id": "bbcf9c9b-22b3-43cf-ba2a-29071dfbd75e", "key": "stripePaymentId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stripe payment" }, "response": [ { "id": "7f7b3b03-1f60-4148-881f-caf349314a4b", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_payments/:stripePaymentId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments", ":stripePaymentId" ], "variable": [ { "key": "stripePaymentId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7f7b3b03-1f60-4148-881f-caf349314a4b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-97160e81-9090-4660-af10-3dab5a283597" } ], "id": "f206931f-8ec7-4010-801e-707e404b3a22", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f206931f-8ec7-4010-801e-707e404b3a22" }, { "name": "List all stripe payments", "id": "52277020-6dfd-4539-8557-03a69c12a27b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stripe_payments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments" ] }, "description": "List all stripe payments" }, "response": [ { "id": "d6caca4f-66d4-4a31-901c-0dbc352bb6fc", "name": "A list of stripe payment objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_payments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stripe_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"connected_account\": \"\",\n \"charge_id\": \"\",\n \"publishable_key\": \"\",\n \"on_behalf_of\": \"\",\n \"transfer_group\": \"\",\n \"options\": {},\n \"payment_method\": {},\n \"mismatched_amounts\": \"\",\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stripe_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"connected_account\": \"\",\n \"charge_id\": \"\",\n \"publishable_key\": \"\",\n \"on_behalf_of\": \"\",\n \"transfer_group\": \"\",\n \"options\": {},\n \"payment_method\": {},\n \"mismatched_amounts\": \"\",\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d6caca4f-66d4-4a31-901c-0dbc352bb6fc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-52277020-6dfd-4539-8557-03a69c12a27b" }, { "name": "Create a stripe payment", "id": "703cfa3e-c17c-4ba5-a14f-4908275f395a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_payments\",\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"options\": {},\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_payments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments" ] }, "description": "Create a stripe payment" }, "response": [ { "id": "8b406b81-06cb-46ec-8775-27b81f8f72cc", "name": "The created stripe payment object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_payments\",\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"options\": {},\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_payments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_payments\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"stripe_id\": \"\",\n \"client_secret\": \"\",\n \"connected_account\": \"\",\n \"charge_id\": \"\",\n \"publishable_key\": \"\",\n \"on_behalf_of\": \"\",\n \"transfer_group\": \"\",\n \"options\": {},\n \"payment_method\": {},\n \"mismatched_amounts\": \"\",\n \"return_url\": \"\",\n \"receipt_email\": \"\",\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_gateway\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_gateway\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8b406b81-06cb-46ec-8775-27b81f8f72cc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-703cfa3e-c17c-4ba5-a14f-4908275f395a" } ], "id": "c10de60d-9dc2-4056-8045-1a803c37c40d", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c10de60d-9dc2-4056-8045-1a803c37c40d" }, { "name": "stripe_tax_accounts", "item": [ { "name": "{stripeTaxAccountId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the stripe tax account", "id": "2c6b601e-883a-4e4f-896c-1da756370dbc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "markets" ], "variable": [ { "id": "5b4c0a30-70d4-41ab-84b9-302e9eab9669", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the stripe tax account" }, "response": [ { "id": "ca8dbb48-7e5d-4fcc-a0cd-da81c0ca8303", "name": "The markets associated to the stripe tax account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "markets" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ca8dbb48-7e5d-4fcc-a0cd-da81c0ca8303" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2c6b601e-883a-4e4f-896c-1da756370dbc" } ], "id": "9e1e2fa6-6724-43bb-bc1e-b19e7fc190b3", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9e1e2fa6-6724-43bb-bc1e-b19e7fc190b3" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the stripe tax account", "id": "41388213-3cc3-4009-8f9c-a0f91f63a02b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "attachments" ], "variable": [ { "id": "c3410e61-71a3-4310-b778-92938e6c82ee", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the stripe tax account" }, "response": [ { "id": "d9b754f0-954d-40ab-a362-4662ba55e611", "name": "The attachments associated to the stripe tax account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "attachments" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d9b754f0-954d-40ab-a362-4662ba55e611" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-41388213-3cc3-4009-8f9c-a0f91f63a02b" } ], "id": "064943c4-0aba-4ef9-8132-9758f8032155", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-064943c4-0aba-4ef9-8132-9758f8032155" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the stripe tax account", "id": "6f297d02-2a1d-4c26-96ee-4147afb6ea39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "events" ], "variable": [ { "id": "f28b2fde-c333-4caa-bb75-970428d22b44", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the stripe tax account" }, "response": [ { "id": "04d1316e-4d1b-46ea-b2ec-1e2d2774f113", "name": "The events associated to the stripe tax account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "events" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-04d1316e-4d1b-46ea-b2ec-1e2d2774f113" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f297d02-2a1d-4c26-96ee-4147afb6ea39" } ], "id": "f0d0899d-58cf-4163-a59b-6b7f05c220d3", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f0d0899d-58cf-4163-a59b-6b7f05c220d3" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the stripe tax account", "id": "a8d7eb87-442a-47be-9efa-837f13fb268d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "event_stores" ], "variable": [ { "id": "1afcfc17-40e8-4b29-bca4-8e0a9853895d", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the stripe tax account" }, "response": [ { "id": "36bef0f9-8220-48ad-a628-961fa38bdb49", "name": "The event_stores associated to the stripe tax account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "event_stores" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-36bef0f9-8220-48ad-a628-961fa38bdb49" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a8d7eb87-442a-47be-9efa-837f13fb268d" } ], "id": "600614e4-ef40-4b5e-b44f-ec070d52c438", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-600614e4-ef40-4b5e-b44f-ec070d52c438" }, { "name": "tax_categories", "item": [ { "name": "Retrieve the tax categories associated to the stripe tax account", "id": "e06d3455-a463-48e0-8abe-794c2d28f13e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "tax_categories" ], "variable": [ { "id": "dfcd67b6-d6b7-4ca5-9200-0b45a30f288c", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tax categories associated to the stripe tax account" }, "response": [ { "id": "99a96379-7938-4697-b152-0f1e928e3326", "name": "The tax_categories associated to the stripe tax account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId", "tax_categories" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-99a96379-7938-4697-b152-0f1e928e3326" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e06d3455-a463-48e0-8abe-794c2d28f13e" } ], "id": "4421155e-39c9-4741-8223-ebfff0f52eba", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4421155e-39c9-4741-8223-ebfff0f52eba" }, { "name": "Retrieve a stripe tax account", "id": "b3a26f0a-bd85-46ee-9ba3-1637cf923cd2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId" ], "variable": [ { "id": "6efbbd10-e743-496f-82be-ce4834bce0a4", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a stripe tax account" }, "response": [ { "id": "262e5575-2dc3-4401-8653-80da4d5dad6a", "name": "The stripe tax account object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-262e5575-2dc3-4401-8653-80da4d5dad6a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b3a26f0a-bd85-46ee-9ba3-1637cf923cd2" }, { "name": "Update a stripe tax account", "id": "8a95e6dc-8755-451d-ba2e-1ffba1a8c095", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_tax_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\",\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId" ], "variable": [ { "id": "03907a71-84d1-40e3-82b5-0271dc88848b", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a stripe tax account" }, "response": [ { "id": "e0790bed-c92c-4f79-b634-2cb4f43be5f3", "name": "The updated stripe tax account object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_tax_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\",\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e0790bed-c92c-4f79-b634-2cb4f43be5f3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8a95e6dc-8755-451d-ba2e-1ffba1a8c095" }, { "name": "Delete a stripe tax account", "id": "1e740717-11dd-4312-aa53-99ed20500534", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId" ], "variable": [ { "id": "75dc7e64-22e4-417f-aa03-324210415a86", "key": "stripeTaxAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a stripe tax account" }, "response": [ { "id": "023d0d1b-2366-4424-8dcd-2b09b9bc4045", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts/:stripeTaxAccountId", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts", ":stripeTaxAccountId" ], "variable": [ { "key": "stripeTaxAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-023d0d1b-2366-4424-8dcd-2b09b9bc4045" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1e740717-11dd-4312-aa53-99ed20500534" } ], "id": "6ffb58d2-7d8c-494b-ba42-8a7b6b50e9f8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6ffb58d2-7d8c-494b-ba42-8a7b6b50e9f8" }, { "name": "List all stripe tax accounts", "id": "6e4b697d-35ac-4e4f-86f9-34ceed0fdc22", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts" ] }, "description": "List all stripe tax accounts" }, "response": [ { "id": "d17b802f-5aba-465a-ba3b-ab84d139f6cb", "name": "A list of stripe tax account objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/stripe_tax_accounts", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"avalara_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d17b802f-5aba-465a-ba3b-ab84d139f6cb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6e4b697d-35ac-4e4f-86f9-34ceed0fdc22" }, { "name": "Create a stripe tax account", "id": "d9d33536-e1bc-4a47-9523-60c7a8effda7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_tax_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_tax_accounts", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts" ] }, "description": "Create a stripe tax account" }, "response": [ { "id": "6760deb4-9228-4817-a550-370da4e7d4d3", "name": "The created stripe tax account object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"stripe_tax_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/stripe_tax_accounts", "host": [ "{{baseUrl}}" ], "path": [ "stripe_tax_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"commit_invoice\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6760deb4-9228-4817-a550-370da4e7d4d3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d9d33536-e1bc-4a47-9523-60c7a8effda7" } ], "id": "9749a7e0-9095-478e-aa4f-045f182b2e0c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9749a7e0-9095-478e-aa4f-045f182b2e0c" }, { "name": "subscription_models", "item": [ { "name": "{subscriptionModelId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the subscription model", "id": "0b05845c-d86d-45fb-b543-61e45de0d42e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/markets", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "markets" ], "variable": [ { "id": "486f1d01-1206-4022-b2bc-e71bb659f523", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the subscription model" }, "response": [ { "id": "aeebbba2-9a7b-4867-9039-11bf95c3ab7f", "name": "The markets associated to the subscription model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/markets", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "markets" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aeebbba2-9a7b-4867-9039-11bf95c3ab7f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0b05845c-d86d-45fb-b543-61e45de0d42e" } ], "id": "9eaa79d8-78bb-4af8-9cab-0e114c7e94ca", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9eaa79d8-78bb-4af8-9cab-0e114c7e94ca" }, { "name": "order_subscriptions", "item": [ { "name": "Retrieve the order subscriptions associated to the subscription model", "id": "2a258db1-70d5-45fb-a9b3-69a8079974ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "order_subscriptions" ], "variable": [ { "id": "ecc68925-794b-494c-bde7-5596b336f137", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order subscriptions associated to the subscription model" }, "response": [ { "id": "a0c64821-aa6b-43e5-bcb2-4e8564c59ede", "name": "The order_subscriptions associated to the subscription model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/order_subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "order_subscriptions" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a0c64821-aa6b-43e5-bcb2-4e8564c59ede" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2a258db1-70d5-45fb-a9b3-69a8079974ad" } ], "id": "887453c5-655b-4fa6-ba3b-6292f710cdfb", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-887453c5-655b-4fa6-ba3b-6292f710cdfb" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the subscription model", "id": "7cde652e-74e9-41af-8837-e1f825133b6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "attachments" ], "variable": [ { "id": "2d58c74f-9cb7-4faa-8076-7cf5a9d2e1d0", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the subscription model" }, "response": [ { "id": "9ca41307-d8fe-4961-9637-56e73d45e007", "name": "The attachments associated to the subscription model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "attachments" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-9ca41307-d8fe-4961-9637-56e73d45e007" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7cde652e-74e9-41af-8837-e1f825133b6c" } ], "id": "3406e22a-9bd5-4ca0-bd3e-5f296d04dcf5", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3406e22a-9bd5-4ca0-bd3e-5f296d04dcf5" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the subscription model", "id": "e27678ef-a0b8-425f-91f9-bea7c45c9b98", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "event_stores" ], "variable": [ { "id": "e37dd445-ceed-4e69-acab-0d99ca6bc454", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the subscription model" }, "response": [ { "id": "03f521f1-1b6e-4ef2-b3fe-85e2be30d3ec", "name": "The event_stores associated to the subscription model", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId", "event_stores" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-03f521f1-1b6e-4ef2-b3fe-85e2be30d3ec" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e27678ef-a0b8-425f-91f9-bea7c45c9b98" } ], "id": "a11107f3-cb2b-4d32-862e-39d2869a7306", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a11107f3-cb2b-4d32-862e-39d2869a7306" }, { "name": "Retrieve a subscription model", "id": "0882ae4c-9d94-4f7d-939f-97bde4bf2a8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId" ], "variable": [ { "id": "022f6df9-4c08-4152-8397-0ca6698a1999", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a subscription model" }, "response": [ { "id": "39d6f126-2464-4f6b-b4ca-5b4255552dbf", "name": "The subscription model object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"subscription_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-39d6f126-2464-4f6b-b4ca-5b4255552dbf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0882ae4c-9d94-4f7d-939f-97bde4bf2a8a" }, { "name": "Update a subscription model", "id": "ad645b2b-3ea9-46bd-80a6-353843b9431f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_models\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId" ], "variable": [ { "id": "b372fc33-848a-4a70-bc62-2c996818e896", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a subscription model" }, "response": [ { "id": "aa6f4340-0c4c-4799-ad86-14a9660a0154", "name": "The updated subscription model object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_models\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"subscription_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aa6f4340-0c4c-4799-ad86-14a9660a0154" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad645b2b-3ea9-46bd-80a6-353843b9431f" }, { "name": "Delete a subscription model", "id": "2ede45bb-93d2-47ab-b580-1fd4a69171ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId" ], "variable": [ { "id": "2ecb9d69-c9a2-41af-80d2-21980c8c4286", "key": "subscriptionModelId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a subscription model" }, "response": [ { "id": "1f0b7ac0-f766-43bf-a1ff-f8e9c771c6c9", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models/:subscriptionModelId", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models", ":subscriptionModelId" ], "variable": [ { "key": "subscriptionModelId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1f0b7ac0-f766-43bf-a1ff-f8e9c771c6c9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2ede45bb-93d2-47ab-b580-1fd4a69171ba" } ], "id": "2f77a530-3c33-4fd1-9af4-066a170dc555", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2f77a530-3c33-4fd1-9af4-066a170dc555" }, { "name": "List all subscription models", "id": "dee93aa7-5e96-4b38-885b-084554b61497", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/subscription_models", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models" ] }, "description": "List all subscription models" }, "response": [ { "id": "f3d0e4ec-8ff5-4c27-bee4-01975edb8880", "name": "A list of subscription model objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/subscription_models", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"subscription_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"subscription_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f3d0e4ec-8ff5-4c27-bee4-01975edb8880" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dee93aa7-5e96-4b38-885b-084554b61497" }, { "name": "Create a subscription model", "id": "68b87138-0d1c-4a85-8595-c7d815672ca3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_models\",\n \"attributes\": {\n \"name\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"strategy\": \"\",\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscription_models", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models" ] }, "description": "Create a subscription model" }, "response": [ { "id": "6a33e630-5172-47b0-a20d-c00a44687935", "name": "The created subscription model object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"subscription_models\",\n \"attributes\": {\n \"name\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"strategy\": \"\",\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/subscription_models", "host": [ "{{baseUrl}}" ], "path": [ "subscription_models" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"subscription_models\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"strategy\": \"\",\n \"frequencies\": [\n \"\",\n \"\"\n ],\n \"auto_activate\": \"\",\n \"auto_cancel\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"order_subscriptions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order_subscriptions\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6a33e630-5172-47b0-a20d-c00a44687935" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-68b87138-0d1c-4a85-8595-c7d815672ca3" } ], "id": "8a8ee405-93a9-4817-a679-d53be4b0b5aa", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8a8ee405-93a9-4817-a679-d53be4b0b5aa" }, { "name": "tags", "item": [ { "name": "{tagId}", "item": [ { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the tag", "id": "199ca5ab-9550-4fd8-aaf8-9b1c70718e87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tags/:tagId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId", "event_stores" ], "variable": [ { "id": "d2fd8a72-7fe6-4768-88c1-0e9fb6602e6e", "key": "tagId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the tag" }, "response": [ { "id": "ef204fe3-fa12-45f5-babb-bfe029208f30", "name": "The event_stores associated to the tag", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tags/:tagId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId", "event_stores" ], "variable": [ { "key": "tagId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ef204fe3-fa12-45f5-babb-bfe029208f30" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-199ca5ab-9550-4fd8-aaf8-9b1c70718e87" } ], "id": "1e392f88-1604-4646-afa1-21c98929aa0e", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1e392f88-1604-4646-afa1-21c98929aa0e" }, { "name": "Retrieve a tag", "id": "98483390-1903-40bd-83d1-6c266438cdcf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "variable": [ { "id": "1fc6d923-2f41-4ecb-a54f-3c3c8c9ce705", "key": "tagId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a tag" }, "response": [ { "id": "fa650493-9cba-4ce8-9def-0352a65fa3a9", "name": "The tag object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "variable": [ { "key": "tagId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tags\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa650493-9cba-4ce8-9def-0352a65fa3a9" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-98483390-1903-40bd-83d1-6c266438cdcf" }, { "name": "Update a tag", "id": "df4c27ea-bb57-418e-9370-6cd4a795c40f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "variable": [ { "id": "e0bc3773-7dd8-406a-983b-397ddc4f9ecf", "key": "tagId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a tag" }, "response": [ { "id": "7284e045-3381-4b1e-ad90-f066b28b253d", "name": "The updated tag object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tags\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "variable": [ { "key": "tagId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tags\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7284e045-3381-4b1e-ad90-f066b28b253d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-df4c27ea-bb57-418e-9370-6cd4a795c40f" }, { "name": "Delete a tag", "id": "b9094e1d-b159-4d34-8900-3752a72fccfa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "variable": [ { "id": "34a15766-3b06-4033-85ab-81ffe6085b52", "key": "tagId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a tag" }, "response": [ { "id": "4e604d2a-4be8-46a2-a707-65769447a262", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tags/:tagId", "host": [ "{{baseUrl}}" ], "path": [ "tags", ":tagId" ], "variable": [ { "key": "tagId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4e604d2a-4be8-46a2-a707-65769447a262" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b9094e1d-b159-4d34-8900-3752a72fccfa" } ], "id": "687fca6f-a6e7-4101-bebf-e3dbd8d17366", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-687fca6f-a6e7-4101-bebf-e3dbd8d17366" }, { "name": "List all tags", "id": "4b29303b-72d9-4a0e-9fa3-135352cb3649", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "tags" ] }, "description": "List all tags" }, "response": [ { "id": "1b2869af-6fde-451d-bd1a-337f4d332bc6", "name": "A list of tag objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "tags" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tags\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tags\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1b2869af-6fde-451d-bd1a-337f4d332bc6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4b29303b-72d9-4a0e-9fa3-135352cb3649" }, { "name": "Create a tag", "id": "6e752d80-d15d-4e4c-87dc-d45d0cbf5a3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tags\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "tags" ] }, "description": "Create a tag" }, "response": [ { "id": "5327062e-fbf0-4b4c-af99-e6c21e836d6a", "name": "The created tag object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tags\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "tags" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tags\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5327062e-fbf0-4b4c-af99-e6c21e836d6a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6e752d80-d15d-4e4c-87dc-d45d0cbf5a3c" } ], "id": "d0ed1470-a01d-4115-bc8f-d243707a5300", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d0ed1470-a01d-4115-bc8f-d243707a5300" }, { "name": "talon_one_accounts", "item": [ { "name": "{talonOneAccountId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the talon one account", "id": "b7bf8bf0-c79f-44d3-9a61-5707796cebc9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "markets" ], "variable": [ { "id": "4ef961bd-c525-43f2-bc3a-6d964aee41ce", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the talon one account" }, "response": [ { "id": "fad7b588-e011-4779-ba54-caadef21c0ce", "name": "The markets associated to the talon one account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "markets" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fad7b588-e011-4779-ba54-caadef21c0ce" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b7bf8bf0-c79f-44d3-9a61-5707796cebc9" } ], "id": "85d187a9-f3fb-46f5-8ac9-7438f006a38c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-85d187a9-f3fb-46f5-8ac9-7438f006a38c" }, { "name": "discount_engine_items", "item": [ { "name": "Retrieve the discount engine items associated to the talon one account", "id": "0ef5ba74-1aca-4bb8-99a5-87df0e737ff0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/discount_engine_items", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "discount_engine_items" ], "variable": [ { "id": "fc781ee7-3b8f-4ce6-b38f-f6c67baf170b", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the discount engine items associated to the talon one account" }, "response": [ { "id": "dd11a916-a48b-4f1f-9437-0bfee75295bd", "name": "The discount_engine_items associated to the talon one account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/discount_engine_items", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "discount_engine_items" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dd11a916-a48b-4f1f-9437-0bfee75295bd" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0ef5ba74-1aca-4bb8-99a5-87df0e737ff0" } ], "id": "3195c753-7cd7-44fb-92f9-5813c8bf6dd5", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3195c753-7cd7-44fb-92f9-5813c8bf6dd5" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the talon one account", "id": "214dfc4e-6720-4eca-80b1-5c506d81af79", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "attachments" ], "variable": [ { "id": "124f38ea-d3cb-487a-9bbc-89fc522abb17", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the talon one account" }, "response": [ { "id": "827c0f64-5011-46c3-8980-e4d627172886", "name": "The attachments associated to the talon one account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "attachments" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-827c0f64-5011-46c3-8980-e4d627172886" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-214dfc4e-6720-4eca-80b1-5c506d81af79" } ], "id": "d5a3d8a9-39a0-48a0-b5a4-1b894cdb359a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d5a3d8a9-39a0-48a0-b5a4-1b894cdb359a" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the talon one account", "id": "80f3ef75-f7fa-480e-bc4f-1cba3ac0b81e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "event_stores" ], "variable": [ { "id": "b46c7bd2-9d67-4a17-a011-25cd71fa1d64", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the talon one account" }, "response": [ { "id": "3bdda277-1cb6-497e-8ed6-81aa901c3b03", "name": "The event_stores associated to the talon one account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId", "event_stores" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3bdda277-1cb6-497e-8ed6-81aa901c3b03" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-80f3ef75-f7fa-480e-bc4f-1cba3ac0b81e" } ], "id": "4f50366a-0446-41f5-93e0-5d05d63bcf48", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4f50366a-0446-41f5-93e0-5d05d63bcf48" }, { "name": "Retrieve a talon one account", "id": "a3069404-7480-4bbb-ab34-550414386ac4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId" ], "variable": [ { "id": "04c1a0da-07b3-4ca4-a438-bf44688957d5", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a talon one account" }, "response": [ { "id": "0aebab82-c534-42de-aa6d-9c5a01219275", "name": "The talon one account object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"talon_one_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_endpoint\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-0aebab82-c534-42de-aa6d-9c5a01219275" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a3069404-7480-4bbb-ab34-550414386ac4" }, { "name": "Update a talon one account", "id": "edbd5389-b020-4139-8893-f5969b2bef4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"talon_one_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"manage_gift_cards\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\",\n \"baseurl\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId" ], "variable": [ { "id": "969ebadf-c749-4caf-bf4d-fa98bd886f55", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a talon one account" }, "response": [ { "id": "1c3ea45f-5870-4be1-9192-db0bb373eb8b", "name": "The updated talon one account object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"talon_one_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"manage_gift_cards\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\",\n \"baseurl\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"talon_one_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_endpoint\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-1c3ea45f-5870-4be1-9192-db0bb373eb8b" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-edbd5389-b020-4139-8893-f5969b2bef4f" }, { "name": "Delete a talon one account", "id": "70350423-f79e-496c-995e-ffa06dbc991e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId" ], "variable": [ { "id": "6625ce7c-e791-4830-addf-87b5a5b65cc7", "key": "talonOneAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a talon one account" }, "response": [ { "id": "38638596-1a3d-46f0-ac9e-3af2f4886d43", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts/:talonOneAccountId", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts", ":talonOneAccountId" ], "variable": [ { "key": "talonOneAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-38638596-1a3d-46f0-ac9e-3af2f4886d43" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-70350423-f79e-496c-995e-ffa06dbc991e" } ], "id": "73abb2a6-3a21-4979-be2f-bb1bf7cd6a12", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-73abb2a6-3a21-4979-be2f-bb1bf7cd6a12" }, { "name": "List all talon one accounts", "id": "28e83fdc-b884-40a1-8353-b19daba25c08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts" ] }, "description": "List all talon one accounts" }, "response": [ { "id": "07fdb0e9-6a8c-4ca7-a70f-eda5b29f51be", "name": "A list of talon one account objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/talon_one_accounts", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"talon_one_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_endpoint\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"talon_one_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_endpoint\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-07fdb0e9-6a8c-4ca7-a70f-eda5b29f51be" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-28e83fdc-b884-40a1-8353-b19daba25c08" }, { "name": "Create a talon one account", "id": "d765207c-d093-4c8c-ba49-a6dc32324d1f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"talon_one_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"baseurl\": \"\",\n \"manage_gift_cards\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/talon_one_accounts", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts" ] }, "description": "Create a talon one account" }, "response": [ { "id": "b9c5f879-506b-4257-ad95-5d67a5d3dd15", "name": "The created talon one account object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"talon_one_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"baseurl\": \"\",\n \"manage_gift_cards\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/talon_one_accounts", "host": [ "{{baseUrl}}" ], "path": [ "talon_one_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"talon_one_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"talon_one_accounts\",\n \"manage_gift_cards\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_endpoint\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"discount_engine_items\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"discount_engine_items\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-b9c5f879-506b-4257-ad95-5d67a5d3dd15" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d765207c-d093-4c8c-ba49-a6dc32324d1f" } ], "id": "1cc6de33-8474-476b-8288-626bbed85f34", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1cc6de33-8474-476b-8288-626bbed85f34" }, { "name": "tax_calculators", "item": [ { "name": "{taxCalculatorId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the tax calculator", "id": "e5d40ff0-af0f-44c5-adc5-6981e4d5edf2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/markets", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "markets" ], "variable": [ { "id": "1f2d57de-e1ce-4dc1-9e59-4207ff6a25bd", "key": "taxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the tax calculator" }, "response": [ { "id": "4db35745-4cda-4732-a022-c3aba653fc29", "name": "The markets associated to the tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/markets", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "markets" ], "variable": [ { "key": "taxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4db35745-4cda-4732-a022-c3aba653fc29" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5d40ff0-af0f-44c5-adc5-6981e4d5edf2" } ], "id": "5c0996ca-eb56-4aaa-a637-22eca3bfbb6a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5c0996ca-eb56-4aaa-a637-22eca3bfbb6a" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the tax calculator", "id": "1a7becd7-abd9-4fd1-8c87-ab798b1fad11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "attachments" ], "variable": [ { "id": "402c4ff7-49a6-40ce-81a6-ffce521338d7", "key": "taxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the tax calculator" }, "response": [ { "id": "298d394f-e337-4179-bf7c-beecd196efd7", "name": "The attachments associated to the tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "attachments" ], "variable": [ { "key": "taxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-298d394f-e337-4179-bf7c-beecd196efd7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1a7becd7-abd9-4fd1-8c87-ab798b1fad11" } ], "id": "959803e5-afea-4335-b2a7-0f02582c14aa", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-959803e5-afea-4335-b2a7-0f02582c14aa" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the tax calculator", "id": "8e3f08cd-b9ba-44e1-a3e7-0fbafd98f171", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/events", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "events" ], "variable": [ { "id": "9c1204c1-ee39-4bc7-8ea2-d1e31465ad14", "key": "taxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the tax calculator" }, "response": [ { "id": "e33eadad-8622-4218-ba82-9a2e731e07e5", "name": "The events associated to the tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/events", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "events" ], "variable": [ { "key": "taxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e33eadad-8622-4218-ba82-9a2e731e07e5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8e3f08cd-b9ba-44e1-a3e7-0fbafd98f171" } ], "id": "01870bcc-3969-4cf5-93f0-71d948c052f0", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-01870bcc-3969-4cf5-93f0-71d948c052f0" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the tax calculator", "id": "5a438337-da64-42f9-bc9a-3498b076d7e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "event_stores" ], "variable": [ { "id": "b4997569-87f4-4e44-b7c7-d79275103a05", "key": "taxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the tax calculator" }, "response": [ { "id": "255ec59b-e19b-40ad-bf9e-c05b5caf0c0f", "name": "The event_stores associated to the tax calculator", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId", "event_stores" ], "variable": [ { "key": "taxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-255ec59b-e19b-40ad-bf9e-c05b5caf0c0f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5a438337-da64-42f9-bc9a-3498b076d7e5" } ], "id": "4518f945-5c9f-482f-bb9a-2836b9c95390", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4518f945-5c9f-482f-bb9a-2836b9c95390" }, { "name": "Retrieve a tax calculator", "id": "9bf08da2-490c-4694-b738-6b31e5b5abf3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId" ], "variable": [ { "id": "311086d4-a07d-4b6e-9d57-e093f2ece49c", "key": "taxCalculatorId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a tax calculator" }, "response": [ { "id": "11d024d7-29e0-40ef-be3f-946b60a71b67", "name": "The tax calculator object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_calculators/:taxCalculatorId", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators", ":taxCalculatorId" ], "variable": [ { "key": "taxCalculatorId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"external_tax_calculators\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-11d024d7-29e0-40ef-be3f-946b60a71b67" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9bf08da2-490c-4694-b738-6b31e5b5abf3" } ], "id": "4327a1d5-b4e9-42af-9f43-43e466d8d9f5", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4327a1d5-b4e9-42af-9f43-43e466d8d9f5" }, { "name": "List all tax calculators", "id": "78c0629d-354e-45dc-98bb-cd6319b6a99f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators" ] }, "description": "List all tax calculators" }, "response": [ { "id": "99448f5c-b074-4cd8-a4f9-fffe0c93236e", "name": "A list of tax calculator objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_calculators", "host": [ "{{baseUrl}}" ], "path": [ "tax_calculators" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tax_calculators\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"manual_tax_calculators\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-99448f5c-b074-4cd8-a4f9-fffe0c93236e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-78c0629d-354e-45dc-98bb-cd6319b6a99f" } ], "id": "67ae7c29-caa0-483e-ac21-7212b6b23e5a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-67ae7c29-caa0-483e-ac21-7212b6b23e5a" }, { "name": "tax_categories", "item": [ { "name": "{taxCategoryId}", "item": [ { "name": "sku", "item": [ { "name": "Retrieve the sku associated to the tax category", "id": "fae3b744-d8b6-4c82-aa16-eb1dfbec431f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId/sku", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId", "sku" ], "variable": [ { "id": "21894b37-08e9-4084-ba19-c066aebd7ac1", "key": "taxCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the sku associated to the tax category" }, "response": [ { "id": "c4602307-22d6-4852-8fcd-05c17e893b0d", "name": "The sku associated to the tax category", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId/sku", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId", "sku" ], "variable": [ { "key": "taxCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-c4602307-22d6-4852-8fcd-05c17e893b0d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fae3b744-d8b6-4c82-aa16-eb1dfbec431f" } ], "id": "33be9fbd-827c-49c3-9825-96274fd02302", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-33be9fbd-827c-49c3-9825-96274fd02302" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the tax category", "id": "dc4c5d0e-b9ea-4353-aa17-4fc981edca44", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId", "attachments" ], "variable": [ { "id": "149c8cb6-7578-4efe-9f25-f2fcb5547718", "key": "taxCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the tax category" }, "response": [ { "id": "43fe9435-11c1-4924-a12e-6c89fe4630da", "name": "The attachments associated to the tax category", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId", "attachments" ], "variable": [ { "key": "taxCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-43fe9435-11c1-4924-a12e-6c89fe4630da" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dc4c5d0e-b9ea-4353-aa17-4fc981edca44" } ], "id": "07ff986d-7f0a-41ea-a9a0-6c9dedf120f3", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-07ff986d-7f0a-41ea-a9a0-6c9dedf120f3" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the tax category", "id": "dde5a482-99fd-4a8d-add9-ec91a996bb1d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId", "event_stores" ], "variable": [ { "id": "c6b55f75-187d-4662-bc12-ed6357e6ba76", "key": "taxCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the tax category" }, "response": [ { "id": "a320c7c8-a7f5-4be7-a1a5-602a936f15fb", "name": "The event_stores associated to the tax category", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId", "event_stores" ], "variable": [ { "key": "taxCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a320c7c8-a7f5-4be7-a1a5-602a936f15fb" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dde5a482-99fd-4a8d-add9-ec91a996bb1d" } ], "id": "01626be3-41f0-4519-a983-57e74d75f4a5", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-01626be3-41f0-4519-a983-57e74d75f4a5" }, { "name": "Retrieve a tax category", "id": "4e5e35fa-8b37-40a3-94aa-3041555df310", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId" ], "variable": [ { "id": "f489c957-f6aa-4396-a2ed-946c2c9c518b", "key": "taxCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a tax category" }, "response": [ { "id": "06d705af-e4df-4e6c-8380-e0c2ed382559", "name": "The tax category object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId" ], "variable": [ { "key": "taxCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-06d705af-e4df-4e6c-8380-e0c2ed382559" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4e5e35fa-8b37-40a3-94aa-3041555df310" }, { "name": "Update a tax category", "id": "46e59b6b-bc3e-4796-92b2-7b299fbc6e93", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId" ], "variable": [ { "id": "41c7e842-49f2-4a41-a938-a19b778b0f55", "key": "taxCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a tax category" }, "response": [ { "id": "aa0ce2eb-f989-4df1-be8d-bfa555b591b7", "name": "The updated tax category object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\",\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId" ], "variable": [ { "key": "taxCategoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-aa0ce2eb-f989-4df1-be8d-bfa555b591b7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-46e59b6b-bc3e-4796-92b2-7b299fbc6e93" }, { "name": "Delete a tax category", "id": "6f6e6fe7-7224-4719-86d7-2470164c8f87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId" ], "variable": [ { "id": "3742d608-80b5-45f6-874c-772c6f902bcd", "key": "taxCategoryId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a tax category" }, "response": [ { "id": "ad0be3df-4c34-4dc8-9640-c674bc1e9cab", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_categories/:taxCategoryId", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories", ":taxCategoryId" ], "variable": [ { "key": "taxCategoryId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ad0be3df-4c34-4dc8-9640-c674bc1e9cab" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f6e6fe7-7224-4719-86d7-2470164c8f87" } ], "id": "e9501a39-dfaf-45a7-a296-caa2ba0f4392", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e9501a39-dfaf-45a7-a296-caa2ba0f4392" }, { "name": "List all tax categories", "id": "30c94bba-66f7-405b-9160-ab9732f72606", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories" ] }, "description": "List all tax categories" }, "response": [ { "id": "537bb882-4b09-41ed-b9b7-c8cd304b60f1", "name": "A list of tax category objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tax_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tax_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-537bb882-4b09-41ed-b9b7-c8cd304b60f1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-30c94bba-66f7-405b-9160-ab9732f72606" }, { "name": "Create a tax category", "id": "a1e9e300-2fca-4067-b449-d738a56b9293", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_categories\",\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"avalara_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories" ] }, "description": "Create a tax category" }, "response": [ { "id": "5690e8d8-b23c-4be7-8f24-add3c8642643", "name": "The created tax category object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_categories\",\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"data\": {\n \"type\": \"skus\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"data\": {\n \"type\": \"avalara_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"avalara_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"username\": \"\",\n \"company_code\": \"\",\n \"commit_invoice\": \"\",\n \"ddp\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "tax_categories" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_categories\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"code\": \"\",\n \"sku_code\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"sku\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"sku\",\n \"id\": \"\"\n }\n },\n \"tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_calculator\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-5690e8d8-b23c-4be7-8f24-add3c8642643" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a1e9e300-2fca-4067-b449-d738a56b9293" } ], "id": "5e20c3b4-4f7d-4601-826a-cf746f506ca7", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5e20c3b4-4f7d-4601-826a-cf746f506ca7" }, { "name": "tax_rules", "item": [ { "name": "{taxRuleId}", "item": [ { "name": "manual_tax_calculator", "item": [ { "name": "Retrieve the manual tax calculator associated to the tax rule", "id": "4ab70dec-77fe-4e01-a8bc-5deb998d11a0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId/manual_tax_calculator", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId", "manual_tax_calculator" ], "variable": [ { "id": "4e1f21ce-9f5b-405b-a3ac-7b61bff63f72", "key": "taxRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the manual tax calculator associated to the tax rule" }, "response": [ { "id": "777fb270-2a2d-40f4-95fb-5116320b028f", "name": "The manual_tax_calculator associated to the tax rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId/manual_tax_calculator", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId", "manual_tax_calculator" ], "variable": [ { "key": "taxRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-777fb270-2a2d-40f4-95fb-5116320b028f" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4ab70dec-77fe-4e01-a8bc-5deb998d11a0" } ], "id": "b7fe5685-54b4-4c26-9341-6c65c413f2bc", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b7fe5685-54b4-4c26-9341-6c65c413f2bc" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the tax rule", "id": "a0b58fcd-2579-4fcb-bed4-5d8eabd1e5c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId", "event_stores" ], "variable": [ { "id": "11d2cb89-27b8-40c7-96dd-5a5cd51ac0a3", "key": "taxRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the tax rule" }, "response": [ { "id": "f1ad11c1-fb7c-42de-a5e7-839efecfa0d7", "name": "The event_stores associated to the tax rule", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId", "event_stores" ], "variable": [ { "key": "taxRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-f1ad11c1-fb7c-42de-a5e7-839efecfa0d7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a0b58fcd-2579-4fcb-bed4-5d8eabd1e5c4" } ], "id": "3489013f-d85c-4136-967d-ea51801e6846", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3489013f-d85c-4136-967d-ea51801e6846" }, { "name": "Retrieve a tax rule", "id": "e5e64436-c26e-4f46-8fd7-38c8c94ca51d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId" ], "variable": [ { "id": "bedccfd5-5e98-4d70-8780-09bcc7778475", "key": "taxRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a tax rule" }, "response": [ { "id": "8ac199c5-c0ed-46af-ad6d-b6013938cab7", "name": "The tax rule object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId" ], "variable": [ { "key": "taxRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"breakdown\": {},\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"manual_tax_calculator\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8ac199c5-c0ed-46af-ad6d-b6013938cab7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5e64436-c26e-4f46-8fd7-38c8c94ca51d" }, { "name": "Update a tax rule", "id": "8bcf4406-cf62-4426-9b29-b3ee0fae17bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId" ], "variable": [ { "id": "0c5e8439-6e0c-4bb5-a286-844bbf2d2937", "key": "taxRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a tax rule" }, "response": [ { "id": "d0287cba-cd2b-4d38-9ce9-bda7e3e2af96", "name": "The updated tax rule object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_rules\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId" ], "variable": [ { "key": "taxRuleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"breakdown\": {},\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"manual_tax_calculator\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d0287cba-cd2b-4d38-9ce9-bda7e3e2af96" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8bcf4406-cf62-4426-9b29-b3ee0fae17bd" }, { "name": "Delete a tax rule", "id": "eda2616b-a3ec-48c1-b671-926327004b3a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId" ], "variable": [ { "id": "74573829-aadb-4a27-aba6-5c747c27f509", "key": "taxRuleId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a tax rule" }, "response": [ { "id": "d48af4d2-bd48-4e36-9dba-28b103952424", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_rules/:taxRuleId", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules", ":taxRuleId" ], "variable": [ { "key": "taxRuleId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d48af4d2-bd48-4e36-9dba-28b103952424" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-eda2616b-a3ec-48c1-b671-926327004b3a" } ], "id": "95fb198c-2870-46d1-889a-eee570a83a39", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-95fb198c-2870-46d1-889a-eee570a83a39" }, { "name": "List all tax rules", "id": "fc83baf7-f5e0-416a-a08c-8cd1b82c8b3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules" ] }, "description": "List all tax rules" }, "response": [ { "id": "562998ad-1e7a-4c53-8fa7-8e5c916f89d5", "name": "A list of tax rule objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"tax_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"breakdown\": {},\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"manual_tax_calculator\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"tax_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"breakdown\": {},\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"manual_tax_calculator\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-562998ad-1e7a-4c53-8fa7-8e5c916f89d5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fc83baf7-f5e0-416a-a08c-8cd1b82c8b3c" }, { "name": "Create a tax rule", "id": "041f93fd-6652-4741-abb1-ad24e412ce94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_rules\",\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules" ] }, "description": "Create a tax rule" }, "response": [ { "id": "04718168-bb0b-41d7-9f1d-da7699b15fad", "name": "The created tax rule object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"tax_rules\",\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"data\": {\n \"type\": \"manual_tax_calculators\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tax_rules", "host": [ "{{baseUrl}}" ], "path": [ "tax_rules" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"tax_rules\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"tax_rate\": \"\",\n \"freight_taxable\": \"\",\n \"payment_method_taxable\": \"\",\n \"gift_card_taxable\": \"\",\n \"adjustment_taxable\": \"\",\n \"breakdown\": {},\n \"country_code_regex\": \"\",\n \"not_country_code_regex\": \"\",\n \"state_code_regex\": \"\",\n \"not_state_code_regex\": \"\",\n \"zip_code_regex\": \"\",\n \"not_zip_code_regex\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"manual_tax_calculator\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"manual_tax_calculator\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-04718168-bb0b-41d7-9f1d-da7699b15fad" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-041f93fd-6652-4741-abb1-ad24e412ce94" } ], "id": "c8941aa2-9bc7-4f2b-a017-d36ab2ade1fe", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c8941aa2-9bc7-4f2b-a017-d36ab2ade1fe" }, { "name": "taxjar_accounts", "item": [ { "name": "{taxjarAccountId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the taxjar account", "id": "75b7c11f-04aa-4511-a035-f92bba7551d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "markets" ], "variable": [ { "id": "cc317515-94a0-4065-b63e-157ac80de533", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the taxjar account" }, "response": [ { "id": "4edaf40e-d41c-4127-8da5-145ecb5d8dda", "name": "The markets associated to the taxjar account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "markets" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4edaf40e-d41c-4127-8da5-145ecb5d8dda" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-75b7c11f-04aa-4511-a035-f92bba7551d8" } ], "id": "c98d43b2-e4c2-4be1-a8cf-e98cefcb7320", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c98d43b2-e4c2-4be1-a8cf-e98cefcb7320" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the taxjar account", "id": "cf514c21-37d6-4eb8-8163-f28b200ed737", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "attachments" ], "variable": [ { "id": "d1ffd016-9704-4660-9411-70a2edf1304a", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the taxjar account" }, "response": [ { "id": "69b12bfc-2b6d-4917-9f70-28af64341617", "name": "The attachments associated to the taxjar account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "attachments" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-69b12bfc-2b6d-4917-9f70-28af64341617" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cf514c21-37d6-4eb8-8163-f28b200ed737" } ], "id": "3463041b-bd1e-43d7-af48-b63c6a91df4a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3463041b-bd1e-43d7-af48-b63c6a91df4a" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the taxjar account", "id": "a5a9c654-84a4-4a70-8fa0-820ccd253e8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "events" ], "variable": [ { "id": "4ef5ea86-bfe8-42a1-80a8-e9b0ae8e7ff7", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the taxjar account" }, "response": [ { "id": "cf317083-0a69-49dc-abb6-f78c98a7d0c0", "name": "The events associated to the taxjar account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "events" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cf317083-0a69-49dc-abb6-f78c98a7d0c0" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a5a9c654-84a4-4a70-8fa0-820ccd253e8a" } ], "id": "51d1336b-c04d-4eba-ad33-d19d1b28216b", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-51d1336b-c04d-4eba-ad33-d19d1b28216b" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the taxjar account", "id": "9ad3c948-6627-47d5-9b33-e0fa7c801c9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "event_stores" ], "variable": [ { "id": "a31b2ed0-4fc3-47cc-8a02-53e4fb1b0713", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the taxjar account" }, "response": [ { "id": "01adf7c2-7591-4d85-b3df-9af40fb698b7", "name": "The event_stores associated to the taxjar account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "event_stores" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-01adf7c2-7591-4d85-b3df-9af40fb698b7" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9ad3c948-6627-47d5-9b33-e0fa7c801c9b" } ], "id": "e5ca8832-4c41-4b5f-9f0d-67b949d12167", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5ca8832-4c41-4b5f-9f0d-67b949d12167" }, { "name": "tax_categories", "item": [ { "name": "Retrieve the tax categories associated to the taxjar account", "id": "bf61287e-82fd-4ee3-a38f-40a8a2eb2ed0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "tax_categories" ], "variable": [ { "id": "d2a55b1d-9008-43bb-a6c6-85544e18c7b9", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the tax categories associated to the taxjar account" }, "response": [ { "id": "dc1dd020-0579-4959-a250-ff2da037f555", "name": "The tax_categories associated to the taxjar account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId/tax_categories", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId", "tax_categories" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-dc1dd020-0579-4959-a250-ff2da037f555" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bf61287e-82fd-4ee3-a38f-40a8a2eb2ed0" } ], "id": "a9357423-e3f7-4a09-9572-3378d7a5972d", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a9357423-e3f7-4a09-9572-3378d7a5972d" }, { "name": "Retrieve a taxjar account", "id": "f052a0b3-98da-42de-b2f6-afbb0bf9f8b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId" ], "variable": [ { "id": "5deef64f-4086-408c-9b84-5a4f26a64c1f", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a taxjar account" }, "response": [ { "id": "adecb4b6-7f13-438a-ab2b-92dcbcd2e5bf", "name": "The taxjar account object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"taxjar_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-adecb4b6-7f13-438a-ab2b-92dcbcd2e5bf" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f052a0b3-98da-42de-b2f6-afbb0bf9f8b2" }, { "name": "Update a taxjar account", "id": "e1ade26a-2e50-42e7-b377-6b437f6f1502", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"taxjar_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId" ], "variable": [ { "id": "9be92be8-42db-43bf-98cc-03ceb5313df0", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a taxjar account" }, "response": [ { "id": "803bb71a-9076-4105-a20c-8ebbba9bb54c", "name": "The updated taxjar account object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"taxjar_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"api_key\": \"\"\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"taxjar_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-803bb71a-9076-4105-a20c-8ebbba9bb54c" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e1ade26a-2e50-42e7-b377-6b437f6f1502" }, { "name": "Delete a taxjar account", "id": "2928cffc-61dc-4217-a254-d2e422612b95", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId" ], "variable": [ { "id": "64ab85bc-a40e-4c7f-82ea-442598eb9e02", "key": "taxjarAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a taxjar account" }, "response": [ { "id": "36486dc7-6e6a-4ecc-b526-14221ac5e604", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts/:taxjarAccountId", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts", ":taxjarAccountId" ], "variable": [ { "key": "taxjarAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-36486dc7-6e6a-4ecc-b526-14221ac5e604" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2928cffc-61dc-4217-a254-d2e422612b95" } ], "id": "d0366acf-aecf-41cf-89f6-7bf24583d023", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d0366acf-aecf-41cf-89f6-7bf24583d023" }, { "name": "List all taxjar accounts", "id": "4058dbbe-2c12-43f1-83f8-7398e16cf56e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts" ] }, "description": "List all taxjar accounts" }, "response": [ { "id": "4023bfcd-31a7-48a6-a14c-68a08070fe4a", "name": "A list of taxjar account objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/taxjar_accounts", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"taxjar_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"taxjar_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"taxjar_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4023bfcd-31a7-48a6-a14c-68a08070fe4a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4058dbbe-2c12-43f1-83f8-7398e16cf56e" }, { "name": "Create a taxjar account", "id": "f181eb6e-c7f3-4d80-a242-cff5dd2dfba9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"taxjar_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxjar_accounts", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts" ] }, "description": "Create a taxjar account" }, "response": [ { "id": "8904c5eb-d3b8-41b8-a498-0252a82b3dc4", "name": "The created taxjar account object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"taxjar_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"api_key\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"tax_categories\": {\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/taxjar_accounts", "host": [ "{{baseUrl}}" ], "path": [ "taxjar_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"taxjar_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"tax_categories\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"tax_categories\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-8904c5eb-d3b8-41b8-a498-0252a82b3dc4" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-f181eb6e-c7f3-4d80-a242-cff5dd2dfba9" } ], "id": "16a0d1bc-2c0e-4e77-b663-daf5886aab94", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-16a0d1bc-2c0e-4e77-b663-daf5886aab94" }, { "name": "transactions", "item": [ { "name": "{transactionId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the transaction", "id": "702921a1-0e63-4fff-985f-0819e84b8f11", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/order", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "order" ], "variable": [ { "id": "7cd298bf-06e6-4b14-8da4-a07735e52ccb", "key": "transactionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the transaction" }, "response": [ { "id": "7d9582db-02e6-4a7c-9a76-bf95df3afc10", "name": "The order associated to the transaction", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/order", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "order" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-7d9582db-02e6-4a7c-9a76-bf95df3afc10" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-702921a1-0e63-4fff-985f-0819e84b8f11" } ], "id": "276dd51b-b86a-403f-b6df-20be01c93f7a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-276dd51b-b86a-403f-b6df-20be01c93f7a" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the transaction", "id": "8961e049-8983-4ba3-904b-b63f167bfa0b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "attachments" ], "variable": [ { "id": "7551e41c-3849-42ad-94c7-c6f3b890114e", "key": "transactionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the transaction" }, "response": [ { "id": "acfc3fb2-c14d-49a9-a779-99d99222ec83", "name": "The attachments associated to the transaction", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "attachments" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-acfc3fb2-c14d-49a9-a779-99d99222ec83" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8961e049-8983-4ba3-904b-b63f167bfa0b" } ], "id": "d7ca2da1-0b79-4ede-862f-6650cdb8c129", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d7ca2da1-0b79-4ede-862f-6650cdb8c129" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the transaction", "id": "33445e64-e778-4af7-a9f8-f15a63b2cee4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/events", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "events" ], "variable": [ { "id": "2067a320-9469-452a-b9e6-f7e63f952b1b", "key": "transactionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the transaction" }, "response": [ { "id": "ede60f14-b0e3-49ff-b26c-d89636e01355", "name": "The events associated to the transaction", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/events", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "events" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-ede60f14-b0e3-49ff-b26c-d89636e01355" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-33445e64-e778-4af7-a9f8-f15a63b2cee4" } ], "id": "19e40482-3f93-4632-a6ac-f58cd58555d4", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-19e40482-3f93-4632-a6ac-f58cd58555d4" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the transaction", "id": "83c64e35-a17d-4791-aaab-e6bdbe1298c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "event_stores" ], "variable": [ { "id": "96955014-0506-4e34-ba30-f18177534fe2", "key": "transactionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the transaction" }, "response": [ { "id": "09b8be93-4fae-4184-a8f5-86bff3cfd40d", "name": "The event_stores associated to the transaction", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId", "event_stores" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-09b8be93-4fae-4184-a8f5-86bff3cfd40d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-83c64e35-a17d-4791-aaab-e6bdbe1298c2" } ], "id": "6f87cda3-dc42-4bdb-a900-d7af701159fc", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6f87cda3-dc42-4bdb-a900-d7af701159fc" }, { "name": "Retrieve a transaction", "id": "e1c11f5d-d7ca-4f69-950b-309a14a25a12", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "id": "eb296a0b-9f85-44f9-821f-11892b25d73e", "key": "transactionId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a transaction" }, "response": [ { "id": "4d3e961c-0d1b-42b1-8612-5a1f262d5126", "name": "The transaction object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/transactions/:transactionId", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":transactionId" ], "variable": [ { "key": "transactionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"transactions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"voids\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4d3e961c-0d1b-42b1-8612-5a1f262d5126" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e1c11f5d-d7ca-4f69-950b-309a14a25a12" } ], "id": "18a2ce64-1a4e-4808-a97e-9784257741b8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-18a2ce64-1a4e-4808-a97e-9784257741b8" }, { "name": "List all transactions", "id": "5f70f9bc-fa62-421d-8d0d-4c3252219576", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] }, "description": "List all transactions" }, "response": [ { "id": "89d73bf5-f937-424a-8990-08f720d6ada8", "name": "A list of transaction objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/transactions", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"transactions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"transactions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"authorizations\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-89d73bf5-f937-424a-8990-08f720d6ada8" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-5f70f9bc-fa62-421d-8d0d-4c3252219576" } ], "id": "a4b25380-35b7-4ad9-a201-62ed228a00a1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a4b25380-35b7-4ad9-a201-62ed228a00a1" }, { "name": "vertex_accounts", "item": [ { "name": "{vertexAccountId}", "item": [ { "name": "markets", "item": [ { "name": "Retrieve the markets associated to the vertex account", "id": "9ee1dc18-9022-4432-9be3-df0ba5884a04", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "markets" ], "variable": [ { "id": "d5339818-31c2-475d-849e-e231e5620d86", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the markets associated to the vertex account" }, "response": [ { "id": "915e4cdc-ec88-4d60-90cf-fd2d960136ea", "name": "The markets associated to the vertex account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/markets", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "markets" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-915e4cdc-ec88-4d60-90cf-fd2d960136ea" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-9ee1dc18-9022-4432-9be3-df0ba5884a04" } ], "id": "8746825e-0b06-4f88-b8fd-b90db50202f0", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-8746825e-0b06-4f88-b8fd-b90db50202f0" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the vertex account", "id": "bc2399e1-a773-483c-b15a-6bb0a1e59c0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "attachments" ], "variable": [ { "id": "0a86864b-1a6f-4cfc-bf3c-f3d41e25fcad", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the vertex account" }, "response": [ { "id": "df17f17e-aa26-413e-9503-c78791b53996", "name": "The attachments associated to the vertex account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "attachments" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df17f17e-aa26-413e-9503-c78791b53996" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-bc2399e1-a773-483c-b15a-6bb0a1e59c0e" } ], "id": "c60f3b47-1cd6-40ec-b94f-995bf89c49b8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c60f3b47-1cd6-40ec-b94f-995bf89c49b8" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the vertex account", "id": "32b681b8-e9b9-4b11-afcb-3a56f0c78f16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "events" ], "variable": [ { "id": "e062a19a-5a71-4878-becf-cabfc12b4783", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the vertex account" }, "response": [ { "id": "25385261-354f-4a06-b2dc-ac545fae4fd3", "name": "The events associated to the vertex account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/events", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "events" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-25385261-354f-4a06-b2dc-ac545fae4fd3" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-32b681b8-e9b9-4b11-afcb-3a56f0c78f16" } ], "id": "a5702da3-de02-41a8-a82a-bf991632f5e1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a5702da3-de02-41a8-a82a-bf991632f5e1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the vertex account", "id": "4e8e7b8c-f406-4714-bfe6-4573ea189dd7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "event_stores" ], "variable": [ { "id": "9f925fc5-51d3-48a6-9eb1-e049259287dc", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the vertex account" }, "response": [ { "id": "26bbb5d8-14f4-46f0-aba2-f0cc5993b68d", "name": "The event_stores associated to the vertex account", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId", "event_stores" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-26bbb5d8-14f4-46f0-aba2-f0cc5993b68d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-4e8e7b8c-f406-4714-bfe6-4573ea189dd7" } ], "id": "cf9d345e-6ac0-4aa4-b073-936f6e534210", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-cf9d345e-6ac0-4aa4-b073-936f6e534210" }, { "name": "Retrieve a vertex account", "id": "660941ab-3ff9-40dd-80ba-a2ca6ae10c92", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId" ], "variable": [ { "id": "e2780ca7-354b-48d8-911b-bc430bab6df6", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a vertex account" }, "response": [ { "id": "29fc0aae-40f1-43a7-98ed-fed980c9c875", "name": "The vertex account object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"vertex_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"cloud\",\n \"baseurl\": \"\",\n \"api_endpoint\": \"\",\n \"commit_invoice\": \"\",\n \"token_expires_at\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-29fc0aae-40f1-43a7-98ed-fed980c9c875" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-660941ab-3ff9-40dd-80ba-a2ca6ae10c92" }, { "name": "Update a vertex account", "id": "2446cf07-dfea-4643-994c-bb8ecd524a42", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"vertex_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"on_demand\",\n \"baseurl\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"commit_invoice\": \"\",\n \"_refresh_token\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId" ], "variable": [ { "id": "d5eced22-056e-47c1-b36b-466a83139ebc", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a vertex account" }, "response": [ { "id": "6371499b-a9f3-4e28-b98a-4f3d21a2656a", "name": "The updated vertex account object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"vertex_accounts\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"on_demand\",\n \"baseurl\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"commit_invoice\": \"\",\n \"_refresh_token\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"vertex_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"cloud\",\n \"baseurl\": \"\",\n \"api_endpoint\": \"\",\n \"commit_invoice\": \"\",\n \"token_expires_at\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-6371499b-a9f3-4e28-b98a-4f3d21a2656a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2446cf07-dfea-4643-994c-bb8ecd524a42" }, { "name": "Delete a vertex account", "id": "02fbe77b-e2ed-4d71-a544-ecd12c294c21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId" ], "variable": [ { "id": "19022f26-0e92-477a-9d5f-4c7eb17b984e", "key": "vertexAccountId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a vertex account" }, "response": [ { "id": "3fc8d5e7-265d-464c-84b4-9ab4ce869c65", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts/:vertexAccountId", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts", ":vertexAccountId" ], "variable": [ { "key": "vertexAccountId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-3fc8d5e7-265d-464c-84b4-9ab4ce869c65" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-02fbe77b-e2ed-4d71-a544-ecd12c294c21" } ], "id": "2097a7e7-3095-43fb-b0c2-ed45ee0ed9d5", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2097a7e7-3095-43fb-b0c2-ed45ee0ed9d5" }, { "name": "List all vertex accounts", "id": "629cf3ab-ccbe-4505-bc53-3acbbee6f9d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/vertex_accounts", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts" ] }, "description": "List all vertex accounts" }, "response": [ { "id": "902d2ca9-f64d-4a52-bec9-ec75632b4ab6", "name": "A list of vertex account objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/vertex_accounts", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"vertex_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"on_demand\",\n \"baseurl\": \"\",\n \"api_endpoint\": \"\",\n \"commit_invoice\": \"\",\n \"token_expires_at\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"vertex_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"vertex_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"on_demand\",\n \"baseurl\": \"\",\n \"api_endpoint\": \"\",\n \"commit_invoice\": \"\",\n \"token_expires_at\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-902d2ca9-f64d-4a52-bec9-ec75632b4ab6" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-629cf3ab-ccbe-4505-bc53-3acbbee6f9d1" }, { "name": "Create a vertex account", "id": "0664c54b-99eb-45ee-9ed9-b180d4303ced", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"vertex_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"on_premise\",\n \"baseurl\": \"\",\n \"commit_invoice\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vertex_accounts", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts" ] }, "description": "Create a vertex account" }, "response": [ { "id": "df5c59cd-3a01-4570-bf49-a07632b2b288", "name": "The created vertex account object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"vertex_accounts\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"on_premise\",\n \"baseurl\": \"\",\n \"commit_invoice\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/vertex_accounts", "host": [ "{{baseUrl}}" ], "path": [ "vertex_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"vertex_accounts\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"type\": \"stripe_tax_accounts\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"kind\": \"cloud\",\n \"baseurl\": \"\",\n \"api_endpoint\": \"\",\n \"commit_invoice\": \"\",\n \"token_expires_at\": \"\"\n },\n \"relationships\": {\n \"markets\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"markets\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-df5c59cd-3a01-4570-bf49-a07632b2b288" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0664c54b-99eb-45ee-9ed9-b180d4303ced" } ], "id": "6c883ee5-705f-4342-819a-3697e6e77296", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6c883ee5-705f-4342-819a-3697e6e77296" }, { "name": "voids", "item": [ { "name": "{voidId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the void", "id": "6497aeee-a537-47e2-82c5-4b22c0c47875", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voids/:voidId/order", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "order" ], "variable": [ { "id": "38ed559b-7465-496c-8305-5664a61374d0", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the void" }, "response": [ { "id": "230211a4-5b14-4c19-9241-0fc6ff7b16c1", "name": "The order associated to the void", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids/:voidId/order", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "order" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-230211a4-5b14-4c19-9241-0fc6ff7b16c1" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6497aeee-a537-47e2-82c5-4b22c0c47875" } ], "id": "e78be127-0b6f-4a5e-b95f-cac988ce5a4a", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e78be127-0b6f-4a5e-b95f-cac988ce5a4a" }, { "name": "attachments", "item": [ { "name": "Retrieve the attachments associated to the void", "id": "e5aea63a-d9a2-4630-8f4b-f88ee3feeabf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voids/:voidId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "attachments" ], "variable": [ { "id": "07c683e1-86e1-483f-b1e0-cd5024005ecf", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the attachments associated to the void" }, "response": [ { "id": "17763382-ca0b-4667-bf4c-346af202c455", "name": "The attachments associated to the void", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids/:voidId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "attachments" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-17763382-ca0b-4667-bf4c-346af202c455" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e5aea63a-d9a2-4630-8f4b-f88ee3feeabf" } ], "id": "b5b590c5-c7af-4e65-b2a0-279314988925", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b5b590c5-c7af-4e65-b2a0-279314988925" }, { "name": "events", "item": [ { "name": "Retrieve the events associated to the void", "id": "0e58b0a0-e3b9-4f1b-9118-c5fbb9205a5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voids/:voidId/events", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "events" ], "variable": [ { "id": "80082d36-0509-43e4-a0b8-197e90f86c0c", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the events associated to the void" }, "response": [ { "id": "09cd13f1-1319-4ec8-93ef-d03e3c70575a", "name": "The events associated to the void", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids/:voidId/events", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "events" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-09cd13f1-1319-4ec8-93ef-d03e3c70575a" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0e58b0a0-e3b9-4f1b-9118-c5fbb9205a5d" } ], "id": "30d462cb-125f-411e-b5b7-3ab313b45734", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-30d462cb-125f-411e-b5b7-3ab313b45734" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the void", "id": "a086ec8e-4db7-4030-9c4b-135031f57e66", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voids/:voidId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "event_stores" ], "variable": [ { "id": "f5c8ac6d-b97e-4a71-b39b-cd56347ae6dc", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the void" }, "response": [ { "id": "e3e64afa-ed3b-4f90-9529-8181b3104826", "name": "The event_stores associated to the void", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids/:voidId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "event_stores" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3e64afa-ed3b-4f90-9529-8181b3104826" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-a086ec8e-4db7-4030-9c4b-135031f57e66" } ], "id": "59692c21-43f1-4f6f-a68d-185c69c433d4", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-59692c21-43f1-4f6f-a68d-185c69c433d4" }, { "name": "reference_authorization", "item": [ { "name": "Retrieve the reference authorization associated to the void", "id": "404c54fe-4a41-424a-ab2a-561939749f82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voids/:voidId/reference_authorization", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "reference_authorization" ], "variable": [ { "id": "093c38a9-4c86-40d6-a4e8-9b367fe6da51", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the reference authorization associated to the void" }, "response": [ { "id": "10f85c15-fd77-4eca-b6c6-22d16f5836cc", "name": "The reference_authorization associated to the void", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids/:voidId/reference_authorization", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId", "reference_authorization" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-10f85c15-fd77-4eca-b6c6-22d16f5836cc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-404c54fe-4a41-424a-ab2a-561939749f82" } ], "id": "e033d63e-cdbc-4f46-b65c-0d0ecc9f6372", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-e033d63e-cdbc-4f46-b65c-0d0ecc9f6372" }, { "name": "Retrieve a void", "id": "2135d3e8-1246-4263-be2c-2bfac7905c86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/voids/:voidId", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId" ], "variable": [ { "id": "413b568a-015d-43b1-a184-5eba6828021d", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a void" }, "response": [ { "id": "cb3d9c4a-3136-4ed1-a86d-9a4c0b02bd87", "name": "The void object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids/:voidId", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"voids\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-cb3d9c4a-3136-4ed1-a86d-9a4c0b02bd87" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2135d3e8-1246-4263-be2c-2bfac7905c86" }, { "name": "Update a void", "id": "decb6a64-2fa5-4d46-893e-193dbdf788a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/voids/:voidId", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId" ], "variable": [ { "id": "3011703c-2637-40b2-ae76-75109dae2fa4", "key": "voidId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a void" }, "response": [ { "id": "e54da0c3-9073-4bd0-82b5-1d1489da7b51", "name": "The updated void object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"voids\",\n \"id\": \"\",\n \"attributes\": {\n \"succeeded\": \"\",\n \"_forward\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/voids/:voidId", "host": [ "{{baseUrl}}" ], "path": [ "voids", ":voidId" ], "variable": [ { "key": "voidId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"voids\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"refunds\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e54da0c3-9073-4bd0-82b5-1d1489da7b51" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-decb6a64-2fa5-4d46-893e-193dbdf788a2" } ], "id": "475766ac-3b24-416a-a349-c1f0d37ef14f", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-475766ac-3b24-416a-a349-c1f0d37ef14f" }, { "name": "List all voids", "id": "46d6835c-53d2-46b1-b8ee-3a8aadd1b794", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/voids", "host": [ "{{baseUrl}}" ], "path": [ "voids" ] }, "description": "List all voids" }, "response": [ { "id": "78aa7249-9641-4083-9cc2-5500e893abae", "name": "A list of void objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/voids", "host": [ "{{baseUrl}}" ], "path": [ "voids" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"voids\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"voids\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"voids\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"number\": \"\",\n \"type\": \"voids\",\n \"payment_method_type\": \"\",\n \"currency_code\": \"\",\n \"amount_cents\": \"\",\n \"amount_float\": \"\",\n \"formatted_amount\": \"\",\n \"succeeded\": \"\",\n \"message\": \"\",\n \"error_code\": \"\",\n \"error_detail\": \"\",\n \"token\": \"\",\n \"gateway_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"payment_source\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"payment_source\",\n \"id\": \"\"\n }\n },\n \"attachments\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"attachments\",\n \"id\": \"\"\n }\n },\n \"events\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"events\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n },\n \"reference_authorization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"reference_authorization\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-78aa7249-9641-4083-9cc2-5500e893abae" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-46d6835c-53d2-46b1-b8ee-3a8aadd1b794" } ], "id": "55b7eb2a-3d60-4e1f-8477-7dd484b38839", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-55b7eb2a-3d60-4e1f-8477-7dd484b38839" }, { "name": "webhooks", "item": [ { "name": "{webhookId}", "item": [ { "name": "last_event_callbacks", "item": [ { "name": "Retrieve the last event callbacks associated to the webhook", "id": "2a789875-7179-440b-bd50-dbbdcb254c26", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/last_event_callbacks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "last_event_callbacks" ], "variable": [ { "id": "b0ea4af2-aa2d-499f-99c9-502100595eb6", "key": "webhookId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the last event callbacks associated to the webhook" }, "response": [ { "id": "edc2916c-9520-405d-b594-ea4b1a3af914", "name": "The last_event_callbacks associated to the webhook", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/last_event_callbacks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "last_event_callbacks" ], "variable": [ { "key": "webhookId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-edc2916c-9520-405d-b594-ea4b1a3af914" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2a789875-7179-440b-bd50-dbbdcb254c26" } ], "id": "fa237d19-c2aa-463a-baa8-93f329132f1c", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-fa237d19-c2aa-463a-baa8-93f329132f1c" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the webhook", "id": "ad8885c0-3653-4fa4-a026-552175a97896", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "event_stores" ], "variable": [ { "id": "7da8148c-e379-463f-ac8b-b192ca206c5a", "key": "webhookId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the webhook" }, "response": [ { "id": "4a556b1e-f1d2-4f6a-abe5-feea5e005582", "name": "The event_stores associated to the webhook", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId", "event_stores" ], "variable": [ { "key": "webhookId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-4a556b1e-f1d2-4f6a-abe5-feea5e005582" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-ad8885c0-3653-4fa4-a026-552175a97896" } ], "id": "856826c0-4f22-472a-969d-892609d471f6", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-856826c0-4f22-472a-969d-892609d471f6" }, { "name": "Retrieve a webhook", "id": "27dbb445-cc8b-4a50-8251-e97412b0009b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "id": "21e7fb6a-cb6b-4698-b1bd-9692b72438a2", "key": "webhookId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a webhook" }, "response": [ { "id": "e3c80fa6-297a-4e92-b49e-b6dbce75aa3d", "name": "The webhook object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhooks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e3c80fa6-297a-4e92-b49e-b6dbce75aa3d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-27dbb445-cc8b-4a50-8251-e97412b0009b" }, { "name": "Update a webhook", "id": "74518d5e-158f-4040-bc4d-192ba5590f1e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"webhooks\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_reset_circuit\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "id": "7b215803-be1e-41e2-adfb-e70f10a1ccd7", "key": "webhookId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a webhook" }, "response": [ { "id": "fa4e1d75-9313-4aed-b013-2d9d1d6bb195", "name": "The updated webhook object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"webhooks\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"_reset_circuit\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhooks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-fa4e1d75-9313-4aed-b013-2d9d1d6bb195" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-74518d5e-158f-4040-bc4d-192ba5590f1e" }, { "name": "Delete a webhook", "id": "3a70a523-4bd2-49f7-8060-35d20f45a4fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "id": "a296dee7-65a4-4e21-aeac-a6f301128528", "key": "webhookId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a webhook" }, "response": [ { "id": "d3f4005f-e151-4b1c-900b-5db856aa8f5e", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-d3f4005f-e151-4b1c-900b-5db856aa8f5e" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-3a70a523-4bd2-49f7-8060-35d20f45a4fe" } ], "id": "c652b993-8608-4c30-93f3-daca9aa4d18e", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-c652b993-8608-4c30-93f3-daca9aa4d18e" }, { "name": "List all webhooks", "id": "b004d9d9-707c-4ad7-b738-487ae7b809ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "description": "List all webhooks" }, "response": [ { "id": "783b8021-3647-4630-9c65-b9e32c288375", "name": "A list of webhook objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"webhooks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"webhooks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-783b8021-3647-4630-9c65-b9e32c288375" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-b004d9d9-707c-4ad7-b738-487ae7b809ba" }, { "name": "Create a webhook", "id": "df9b601d-a85f-48fc-bba6-7699a1ca155e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"webhooks\",\n \"attributes\": {\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"name\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "description": "Create a webhook" }, "response": [ { "id": "95c1a2c2-9390-4d9a-9055-0ca561d31514", "name": "The created webhook object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"webhooks\",\n \"attributes\": {\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"name\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"_disable\": \"\",\n \"_enable\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"webhooks\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"topic\": \"\",\n \"callback_url\": \"\",\n \"include_resources\": [\n \"\",\n \"\"\n ],\n \"disabled_at\": \"\",\n \"circuit_state\": \"\",\n \"circuit_failure_count\": \"\",\n \"shared_secret\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"last_event_callbacks\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"last_event_callbacks\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-95c1a2c2-9390-4d9a-9055-0ca561d31514" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-df9b601d-a85f-48fc-bba6-7699a1ca155e" } ], "id": "dba0bd29-339e-4dd8-815a-2b5c83d1abb4", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-dba0bd29-339e-4dd8-815a-2b5c83d1abb4" }, { "name": "wire_transfers", "item": [ { "name": "{wireTransferId}", "item": [ { "name": "order", "item": [ { "name": "Retrieve the order associated to the wire transfer", "id": "0103c6b9-cf70-4d6e-ad22-70fe19957ca6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId/order", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId", "order" ], "variable": [ { "id": "25c6e960-bc61-4f95-bb8c-e4807214aa62", "key": "wireTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the order associated to the wire transfer" }, "response": [ { "id": "e20edcc5-d312-4b3b-b02c-db14c3488314", "name": "The order associated to the wire transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId/order", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId", "order" ], "variable": [ { "key": "wireTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e20edcc5-d312-4b3b-b02c-db14c3488314" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-0103c6b9-cf70-4d6e-ad22-70fe19957ca6" } ], "id": "1174beb9-7b33-4d50-8332-88b189a5d6d1", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1174beb9-7b33-4d50-8332-88b189a5d6d1" }, { "name": "event_stores", "item": [ { "name": "Retrieve the event stores associated to the wire transfer", "id": "450cee2e-971a-41ad-b6af-c3228cff0366", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId", "event_stores" ], "variable": [ { "id": "823eedce-ba1e-4b30-ba63-580433a21809", "key": "wireTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve the event stores associated to the wire transfer" }, "response": [ { "id": "e03dd7af-b564-48cf-867e-8f69b353dfbc", "name": "The event_stores associated to the wire transfer", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId/event_stores", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId", "event_stores" ], "variable": [ { "key": "wireTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-e03dd7af-b564-48cf-867e-8f69b353dfbc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-450cee2e-971a-41ad-b6af-c3228cff0366" } ], "id": "7d9e98ec-6b60-44f4-b4c0-e419888f94d8", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-7d9e98ec-6b60-44f4-b4c0-e419888f94d8" }, { "name": "Retrieve a wire transfer", "id": "531a6c1c-d08b-425c-bee2-bcfe0a2d5b9d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId" ], "variable": [ { "id": "bc9b4c97-0c53-4b26-91c8-46f903b49461", "key": "wireTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Retrieve a wire transfer" }, "response": [ { "id": "a4459e89-7c8d-48cf-b479-75e5a1943040", "name": "The wire transfer object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId" ], "variable": [ { "key": "wireTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"wire_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a4459e89-7c8d-48cf-b479-75e5a1943040" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-531a6c1c-d08b-425c-bee2-bcfe0a2d5b9d" }, { "name": "Update a wire transfer", "id": "02951d9f-e564-47d7-ad06-46c0594eac2f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wire_transfers\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId" ], "variable": [ { "id": "a8a44e69-eb6f-4bd3-8918-31090db8f09e", "key": "wireTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Update a wire transfer" }, "response": [ { "id": "a5e6625e-a189-46b4-9205-6d976c8ccfce", "name": "The updated wire transfer object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wire_transfers\",\n \"id\": \"\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId" ], "variable": [ { "key": "wireTransferId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"wire_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a5e6625e-a189-46b4-9205-6d976c8ccfce" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-02951d9f-e564-47d7-ad06-46c0594eac2f" }, { "name": "Delete a wire transfer", "id": "1afa4359-b17a-4361-9c9a-66afb8b043f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId" ], "variable": [ { "id": "e100884f-a194-4f50-a6aa-660a88bef4ee", "key": "wireTransferId", "value": "", "description": "(Required) The resource's id" } ] }, "description": "Delete a wire transfer" }, "response": [ { "id": "a506ea37-64bd-4e1a-835f-5ff4ac96860d", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/wire_transfers/:wireTransferId", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers", ":wireTransferId" ], "variable": [ { "key": "wireTransferId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a506ea37-64bd-4e1a-835f-5ff4ac96860d" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-1afa4359-b17a-4361-9c9a-66afb8b043f0" } ], "id": "d0317db0-68e0-4d71-a0fe-a1792087df3e", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-d0317db0-68e0-4d71-a0fe-a1792087df3e" }, { "name": "List all wire transfers", "id": "2049aadf-a351-4007-b654-e627b3d13c7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/wire_transfers", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers" ] }, "description": "List all wire transfers" }, "response": [ { "id": "52c79e39-2b8a-4398-a608-9f52fc921dcc", "name": "A list of wire transfer objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/wire_transfers", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"wire_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"wire_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-52c79e39-2b8a-4398-a608-9f52fc921dcc" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2049aadf-a351-4007-b654-e627b3d13c7c" }, { "name": "Create a wire transfer", "id": "6d5b4b54-acbb-4744-9c1e-70a6d8a9d213", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wire_transfers\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wire_transfers", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers" ] }, "description": "Create a wire transfer" }, "response": [ { "id": "a1423242-30d4-44b8-8322-1ec9238c9ab5", "name": "The created wire transfer object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"wire_transfers\",\n \"attributes\": {\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"data\": {\n \"type\": \"orders\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wire_transfers", "host": [ "{{baseUrl}}" ], "path": [ "wire_transfers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"wire_transfers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"payment_instrument\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"order\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"order\",\n \"id\": \"\"\n }\n },\n \"event_stores\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"event_stores\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:17.000Z", "updatedAt": "2026-06-05T15:07:17.000Z", "uid": "35240-a1423242-30d4-44b8-8322-1ec9238c9ab5" } ], "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-6d5b4b54-acbb-4744-9c1e-70a6d8a9d213" } ], "id": "2cf3fd8e-fc70-4f17-a1e9-2092bfa0e7c6", "createdAt": "2026-06-05T15:07:15.000Z", "updatedAt": "2026-06-05T15:07:15.000Z", "uid": "35240-2cf3fd8e-fc70-4f17-a1e9-2092bfa0e7c6" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://{{your_organization_slug}}.commercelayer.io/api" } ] }