{ "info" : { "name" : "Mirakl Marketplace APIs - Seller", "schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variables" : [ ], "item" : [ { "name" : "Incidents", "item" : [ { "name" : "OR64 - Mark an incident as resolved", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/lines/:line/resolve_incident", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "lines", ":line", "resolve_incident" ], "variable" : [ { "key" : ":order_id", "value" : "value" }, { "key" : ":line", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"reason_code\": \"8\"\n}\n", "mode" : "raw" } }, "response" : [ ] } ] }, { "name" : "Invoicing and Accounting", "item" : [ { "name" : "DR11 - List accounting documents requests", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/document-request/requests", "host" : [ "{{URL}}" ], "path" : [ "", "api", "document-request", "requests" ], "variable" : null, "query" : [ { "key" : "id", "value" : "", "disabled" : true }, { "key" : "document_number", "value" : "", "disabled" : true }, { "key" : "date_created_from", "value" : "", "disabled" : true }, { "key" : "date_created_to", "value" : "", "disabled" : true }, { "key" : "last_updated_from", "value" : "", "disabled" : true }, { "key" : "last_updated_to", "value" : "", "disabled" : true }, { "key" : "issue_date_from", "value" : "", "disabled" : true }, { "key" : "issue_date_to", "value" : "", "disabled" : true }, { "key" : "state", "value" : "", "disabled" : true }, { "key" : "type", "value" : "", "disabled" : true }, { "key" : "issuer_type", "value" : "", "disabled" : true }, { "key" : "entity_id", "value" : "", "disabled" : true }, { "key" : "entity_type", "value" : "", "disabled" : true }, { "key" : "shop_billing_cycle_id", "value" : "", "disabled" : true }, { "key" : "shop_billing_cycle_from", "value" : "", "disabled" : true }, { "key" : "shop_billing_cycle_to", "value" : "", "disabled" : true }, { "key" : "payment_state", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "DR12 - List lines of a document request", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/document-request/:document_request_id/lines", "host" : [ "{{URL}}" ], "path" : [ "", "api", "document-request", ":document_request_id", "lines" ], "variable" : [ { "key" : ":document_request_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "DR73 - Download accounting documents", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/document-request/documents/download", "host" : [ "{{URL}}" ], "path" : [ "", "api", "document-request", "documents", "download" ], "variable" : null, "query" : [ { "key" : "document_request_id", "value" : "", "disabled" : true }, { "key" : "document_id", "value" : "", "disabled" : true }, { "key" : "document_format", "value" : "", "disabled" : true }, { "key" : "entity_id", "value" : "", "disabled" : true }, { "key" : "entity_type", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "DR74 - Upload accounting documents", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/document-request/documents/upload", "host" : [ "{{URL}}" ], "path" : [ "", "api", "document-request", "documents", "upload" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "documents_input", "type" : "text", "contentType" : "application/json", "value" : null, "description" : "Information about documents to be uploaded" }, { "key" : "files", "type" : "file", "contentType" : null, "value" : null, "description" : null } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "DR75 - Confirm accounting documents issuance", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/document-request/documents/confirm-issuance", "host" : [ "{{URL}}" ], "path" : [ "", "api", "document-request", "documents", "confirm-issuance" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"requests\" : [ {\n \"request_id\" : \"4a29570a-5382-45af-9697-057de50f48a4\",\n \"document_number\" : \"INV-2022-0001\",\n \"issue_date\" : \"2022-01-02T00:00:00Z\",\n \"due_date\" : \"2022-02-02T00:00:00Z\",\n \"total_amount_excluding_taxes\" : 32000,\n \"total_tax_amount\" : 512\n }, {\n \"request_id\" : \"7fd2bc17-5ca8-4383-a3b8-bb7e3ec6daf1\",\n \"document_number\" : \"INV-2022-0002\",\n \"issue_date\" : \"2022-01-02T00:00:00Z\",\n \"due_date\" : \"2022-02-02T00:00:00Z\",\n \"total_amount_excluding_taxes\" : 32000,\n \"total_tax_amount\" : 512\n } ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "IV01 - List accounting documents", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/invoices", "host" : [ "{{URL}}" ], "path" : [ "", "api", "invoices" ], "variable" : null, "query" : [ { "key" : "currency", "value" : "", "disabled" : true }, { "key" : "end_date", "value" : "", "disabled" : true }, { "key" : "invoice_id", "value" : "", "disabled" : true }, { "key" : "issuing_user_types", "value" : "", "disabled" : true }, { "key" : "pay_out_psp_codes", "value" : "", "disabled" : true }, { "key" : "payment_status", "value" : "", "disabled" : true }, { "key" : "seller_billing_cycle_id", "value" : "", "disabled" : true }, { "key" : "start_date", "value" : "", "disabled" : true }, { "key" : "type", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "IV02 - Download an accounting document", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/invoices/:accounting_document_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "invoices", ":accounting_document_id" ], "variable" : [ { "key" : ":accounting_document_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "SBC11 - List seller billing cycles", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/seller-billing-cycles", "host" : [ "{{URL}}" ], "path" : [ "", "api", "seller-billing-cycles" ], "variable" : null, "query" : [ { "key" : "currency", "value" : "", "disabled" : true }, { "key" : "end_date", "value" : "", "disabled" : true }, { "key" : "id", "value" : "", "disabled" : true }, { "key" : "pay_out_psp_code", "value" : "", "disabled" : true }, { "key" : "pay_out_state", "value" : "", "disabled" : true }, { "key" : "start_date", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "TL02 - List transaction lines", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/sellerpayment/transactions_logs", "host" : [ "{{URL}}" ], "path" : [ "", "api", "sellerpayment", "transactions_logs" ], "variable" : null, "query" : [ { "key" : "seller_billing_cycle_id", "value" : "", "disabled" : true }, { "key" : "date_created_from", "value" : "", "disabled" : true }, { "key" : "date_created_to", "value" : "", "disabled" : true }, { "key" : "transaction_date_from", "value" : "", "disabled" : true }, { "key" : "transaction_date_to", "value" : "", "disabled" : true }, { "key" : "last_updated_from", "value" : "", "disabled" : true }, { "key" : "payment_state", "value" : "", "disabled" : true }, { "key" : "transaction_type", "value" : "", "disabled" : true }, { "key" : "accounting_document_number", "value" : "", "disabled" : true }, { "key" : "order_id", "value" : "", "disabled" : true }, { "key" : "order_line_id", "value" : "", "disabled" : true }, { "key" : "order_reference_for_customer", "value" : "", "disabled" : true }, { "key" : "order_reference_for_seller", "value" : "", "disabled" : true }, { "key" : "accounting_document_id", "value" : "", "disabled" : true }, { "key" : "shop_model", "value" : "", "disabled" : true }, { "key" : "pay_out_psp_codes", "value" : "", "disabled" : true }, { "key" : "other_reference", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "TL03 - Export transaction lines JSON file asynchronously", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/sellerpayment/transactions_logs/async", "host" : [ "{{URL}}" ], "path" : [ "", "api", "sellerpayment", "transactions_logs", "async" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"Transaction_date_from\" : \"2021-11-12T02:34:00Z\",\n \"megabytes_per_chunk\" : \"10\",\n \"shop_domain\" : [ \"PRODUCT\" ],\n \"transaction_type\" : [ \"MANUAL_CREDIT\" ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "TL04 - Poll the status of an asynchronous transaction log export (TL03)", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/sellerpayment/transactions_logs/async/status/:tracking_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "sellerpayment", "transactions_logs", "async", "status", ":tracking_id" ], "variable" : [ { "key" : ":tracking_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] } ] }, { "name" : "Messages", "item" : [ { "name" : "M10 - Retrieve a thread", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/inbox/threads/:thread_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "inbox", "threads", ":thread_id" ], "variable" : [ { "key" : ":thread_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "M11 - List all threads", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/inbox/threads", "host" : [ "{{URL}}" ], "path" : [ "", "api", "inbox", "threads" ], "variable" : null, "query" : [ { "key" : "entity_type", "value" : "", "disabled" : true }, { "key" : "entity_id", "value" : "", "disabled" : true }, { "key" : "updated_since", "value" : "", "disabled" : true }, { "key" : "with_messages", "value" : "", "disabled" : true }, { "key" : "channel_codes", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "M12 - Reply to a thread", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/inbox/threads/:thread_id/message", "host" : [ "{{URL}}" ], "path" : [ "", "api", "inbox", "threads", ":thread_id", "message" ], "variable" : [ { "key" : ":thread_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "files", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "message_input", "type" : "text", "contentType" : "application/json", "value" : "{\n \"body\": \"I was delighted to receive your offer but ...\",\n \"to\": [\n {\n \"id\": \"152\",\n \"type\": \"SHOP\"\n },\n {\n \"type\": \"OPERATOR\"\n }\n ],\n \"topic\": {\n \"type\": \"FREE_TEXT\",\n \"value\": \"Updated thread topic\"\n }\n}\n\n", "description" : "The message data" } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "M13 - Download an attachment", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/inbox/threads/:attachment_id/download", "host" : [ "{{URL}}" ], "path" : [ "", "api", "inbox", "threads", ":attachment_id", "download" ], "variable" : [ { "key" : ":attachment_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "M14 - Create a thread with the operator", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/inbox/threads", "host" : [ "{{URL}}" ], "path" : [ "", "api", "inbox", "threads" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "files", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "thread_input", "type" : "text", "contentType" : "application/json", "value" : null, "description" : "Message and thread data" } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "OR43 - Create a thread on an order", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/orders/:order_id/threads", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "threads" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "files", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "thread_input", "type" : "text", "contentType" : "application/json", "value" : "{\n \"body\": \"This is an example body\",\n \"topic\": {\n \"type\": \"FREE_TEXT\",\n \"value\": \"This is an example\"\n },\n \"to\": [\"SHOP\", \"OPERATOR\"]\n}\n", "description" : "Thread content: body, topic, participants..." } ], "mode" : "formdata" } }, "response" : [ ] } ] }, { "name" : "Multiple shipments", "item" : [ { "name" : "ST01 - Create shipments", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/shipments", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"order_id\": \"ORDER_01-A\",\n \"invoice_reference\": \"ABCDEF012345\",\n \"tracking\": {\n \"carrier_code\": \"UPS\",\n \"carrier_standard_code\": \"UPS\",\n \"carrier_name\": \"UPS\",\n \"tracking_number\": \"1Z2356F1ZJ98L9733M5\",\n \"tracking_url\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}\"\n },\n \"shipment_lines\": [\n {\n \"offer_sku\": \"OFFER_SKU_1\",\n \"package_reference\": \"package_ref_1\",\n \"quantity\": 1\n },\n {\n \"offer_sku\": \"OFFER_SKU_2\",\n \"package_reference\": \"package_ref_2\",\n \"quantity\": 3\n }\n ],\n \"shipped\": false,\n \"shipping_from\": {\n \"warehouse\": {\n \"code\": \"DEFAULT_WAREHOUSE\"\n }\n },\n \"shipment_additional_information\": [\n {\n \"code\": \"DELIVERY_BILL_ID\",\n \"type\": \"STRING\",\n \"value\": \"IUYHJ777-98\"\n },\n {\n \"code\": \"DELIVERY_BILL_DATE\",\n \"type\": \"DATE\",\n \"value\": \"2024-01-01\"\n }\n ]\n },\n {\n \"order_id\": \"ORDER_01-A\",\n \"invoice_reference\": \"ABCDEF012345\",\n \"tracking\": {\n \"carrier_name\": \"Custom carrier\",\n \"tracking_url\": \"http://www.customcarrier.com/tracking\"\n },\n \"shipment_lines\": [\n {\n \"order_line_id\": \"ORDER_01-A-1\",\n \"package_reference\": \"package_ref_1\",\n \"quantity\": 1\n },\n {\n \"order_line_id\": \"ORDER_01-A-2\",\n \"package_reference\": \"package_ref_2\",\n \"quantity\": 3\n }\n ],\n \"shipped\": true,\n \"shipment_additional_information\": null\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "ST06 - Delete shipments", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/shipments/delete", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments", "delete" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"id\": \"e2055970-dd6c-4d66-b005-096d6e6e0f30\"\n },\n {\n \"id\": \"89174558-2845-44ef-bd57-78db027947f7\"\n },\n {\n \"id\": \"14d134a1-eb3a-442c-b16c-05a35486d1bf\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "ST07 - Update shipment shipping origin", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/shipments", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"id\": \"5b2269b6-3918-43bc-9262-fddd815398f3\",\n \"shipping_from\": {\n \"warehouse\": {\n \"code\": \"WHC1\"\n }\n }\n },\n {\n \"id\": \"0e450a4c-704f-4e2c-845a-71b65b4ff16a\",\n \"shipping_from\": {\n \"warehouse\": {\n \"code\": \"WHC2\"\n }\n }\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "ST11 - List shipments", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipments", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments" ], "variable" : null, "query" : [ { "key" : "order_id", "value" : "", "disabled" : true }, { "key" : "shipment_state_code", "value" : "", "disabled" : true }, { "key" : "shipment_customer_debit_state_code", "value" : "", "disabled" : true }, { "key" : "last_updated_from", "value" : "", "disabled" : true }, { "key" : "last_updated_to", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "ST12 - List items to ship", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipments/items_to_ship", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments", "items_to_ship" ], "variable" : null, "query" : [ { "key" : "order_id", "value" : "", "disabled" : true }, { "key" : "fulfillment_center_code", "value" : "", "disabled" : true }, { "key" : "shipping_date_from", "value" : "", "disabled" : true }, { "key" : "shipping_date_to", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "ST23 - Update carrier tracking information for shipments", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/shipments/tracking", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments", "tracking" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"id\": \"f40bf65e-a320-41d3-878c-36ce9e1144ce\",\n \"tracking\": {\n \"carrier_code\": \"UPS\",\n \"carrier_standard_code\": \"UPS\",\n \"carrier_name\": \"UPS\",\n \"tracking_number\": \"1Z2356F1ZJ98L9733M5\",\n \"tracking_url\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}\"\n }\n },\n {\n \"id\": \"ff341bfe-ebeb-4211-848b-77fcbcd91723\",\n \"tracking\": {\n \"carrier_code\": \"UPS\",\n \"carrier_standard_code\": \"UPS\",\n \"carrier_name\": \"UPS\",\n \"tracking_number\": \"1Z2356F1ZJ98L9733M5\",\n \"tracking_url\": \"https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}\"\n }\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "ST24 - Validate shipments as shipped", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/shipments/ship", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments", "ship" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"id\": \"f40bf65e-a320-41d3-878c-36ce9e1144ce\"\n },\n {\n \"id\": \"c8ca3759-a81b-4abe-afd0-93a418e83ae8\"\n },\n {\n \"id\": \"ff341bfe-ebeb-4211-848b-77fcbcd91723\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "ST26 - Validate shipments as ready to pick up", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/shipments/ready_for_pick_up", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments", "ready_for_pick_up" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"id\": \"f40bf65e-a320-41d3-878c-36ce9e1144ce\"\n },\n {\n \"id\": \"c8ca3759-a81b-4abe-afd0-93a418e83ae8\"\n },\n {\n \"id\": \"ff341bfe-ebeb-4211-848b-77fcbcd91723\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "ST31 - Update shipment additional information", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/shipments/additional_information", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipments", "additional_information" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"shipments\": [\n {\n \"id\": \"4dd549d5-3b5b-4237-a77c-a084359f93z\",\n \"shipment_additional_information\": [\n {\n \"code\": \"IMEI\",\n \"type\": \"STRING\",\n \"value\": \"38021999921000\"\n },\n {\n \"code\": \"DELIVERY_BILL_ID\",\n \"type\": \"STRING\",\n \"value\": \"invalid value with spaces\"\n }\n ]\n },\n {\n \"id\": \"245365B0-D003-4DB7-B23F-5C0A48E93E53\",\n \"shipment_additional_information\": [\n {\n \"code\": \"DELIVERY_BILL_DATE\",\n \"type\": \"DATE\",\n \"value\": \"2024-01-01\"\n },\n {\n \"code\": \"DELIVERY_BILL_ID\",\n \"type\": \"STRING\",\n \"value\": \"IUYHJ777-98\"\n }\n ]\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] } ] }, { "name" : "Offers", "item" : [ { "name" : "OF01 - Import a file to create, update or delete offers", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/offers/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "imports" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "file", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "import_mode", "type" : "text", "contentType" : null, "value" : null, "description" : null }, { "key" : "operator_format", "type" : "text", "contentType" : null, "value" : null, "description" : "Force the use of the operator product format" }, { "key" : "with_products", "type" : "text", "contentType" : null, "value" : null, "description" : "This file also contains product information" } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "OF02 - Get information and statistics about an offer import", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/imports/:import", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "imports", ":import" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OF03 - Get the error report file for an offer import", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/imports/:import/error_report", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "imports", ":import", "error_report" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "OF04 - Get information and statistics about offer imports", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "imports" ], "variable" : null, "query" : [ { "key" : "start_date", "value" : "", "disabled" : true }, { "key" : "end_date", "value" : "", "disabled" : true }, { "key" : "status", "value" : "", "disabled" : true }, { "key" : "mode", "value" : "", "disabled" : true }, { "key" : "origins", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OF21 - List offers of a shop", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers" ], "variable" : null, "query" : [ { "key" : "offer_state_codes", "value" : "", "disabled" : true }, { "key" : "sku", "value" : "", "disabled" : true }, { "key" : "product_id", "value" : "", "disabled" : true }, { "key" : "favorite", "value" : "", "disabled" : true }, { "key" : "pricing_channel_code", "value" : "", "disabled" : true }, { "key" : "pricing_customer_organization_id", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OF22 - Get information about an offer", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/:offer", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", ":offer" ], "variable" : [ { "key" : ":offer", "value" : "value" } ], "query" : [ { "key" : "pricing_channel_code", "value" : "", "disabled" : true }, { "key" : "pricing_customer_organization_id", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OF24 - Create, update, or delete offers", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/offers", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"offers\": [\n {\n \"allow_quote_requests\": false,\n \"available_ended\": \"2019-05-29T22:00:00Z\",\n \"available_started\": \"2019-03-01T22:00:00Z\",\n \"description\": \"Offer for product MKP100000000154824\",\n \"discount\": {\n \"end_date\": \"2019-05-31T22:00:00Z\",\n \"price\": 49,\n \"ranges\": [\n {\n \"price\": 45,\n \"quantity_threshold\": 5\n }\n ],\n \"start_date\": \"2019-03-31T22:00:00Z\"\n },\n \"internal_description\": \"Offer for product MKP100000000154824\",\n \"leadtime_to_ship\": 5,\n \"logistic_class\": \"M\",\n \"max_order_quantity\": 3,\n \"min_order_quantity\": 1,\n \"min_quantity_alert\": 2,\n \"offer_additional_fields\": [\n {\n \"code\": \"ecotax\",\n \"value\": \"20\"\n }\n ],\n \"package_quantity\": \"2\",\n \"price\": 50,\n \"price_additional_info\": \"Apply Discount prices\",\n \"all_prices\": [\n {\n \"channel_code\": \"US\",\n \"discount_end_date\": \"2019-04-29T22:00:00Z\",\n \"discount_start_date\": \"2019-04-01T22:00:00Z\",\n \"unit_discount_price\": \"49\",\n \"unit_origin_price\": 50,\n \"volume_prices\": [\n {\n \"quantity_threshold\": 5,\n \"unit_discount_price\": 45,\n \"unit_origin_price\": 48\n }\n ]\n }\n ],\n \"product_id\": \"9400016774345\",\n \"product_id_type\": \"EAN\",\n \"product_tax_code\": \"tax\",\n \"eco_contributions\": [\n {\n \"epr_category_code\": \"FR-DEA\",\n \"producer_id\": \"FR123456_89ABCD\",\n \"eco_contribution_amount\": 3.59\n },\n {\n \"epr_category_code\": \"DE-WEEE\",\n \"producer_id\": \"ProducerID1\",\n \"eco_contribution_amount\": 0.99\n }\n ],\n \"quantity\": \"5000\",\n \"shop_sku\": \"Offer_SKU_001\",\n \"state_code\": \"11\",\n \"update_delete\": \"update\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OF51 - Get offers CSV file", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/export", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "export" ], "variable" : null, "query" : [ { "key" : "last_request_date", "value" : "", "disabled" : true }, { "key" : "channel_codes", "value" : "", "disabled" : true }, { "key" : "shipping_zones", "value" : "", "disabled" : true }, { "key" : "include_inactive_offers", "value" : "", "disabled" : true }, { "key" : "include_fields", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "text/csv" } ], "body" : null }, "response" : [ ] }, { "name" : "OF52 - Export offers CSV or JSON file asynchronously", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/offers/export/async", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "export", "async" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"channel_codes\": [\n \"B2B\"\n ],\n \"export_type\": \"text/csv\",\n \"last_request_date\": \"2021-11-12T02:34:00Z\",\n \"include_fields\": [\n \"active\",\n \"allow-quote-requests\",\n \"available-end-date\",\n \"available-start-date\",\n \"channels\",\n \"currency-iso-code\",\n \"date-created\",\n \"deleted\",\n \"description\",\n \"discount-end-date\",\n \"discount-price\",\n \"discount-ranges\",\n \"discount-start-date\",\n \"favorite-rank\",\n \"fulfillment-center-code\",\n \"leadtime-to-ship\",\n \"logistic-class\",\n \"measurement-units\",\n \"min-shipping-price\",\n \"min-shipping-price-additional\",\n \"min-shipping-type\",\n \"min-shipping-zone\",\n \"offer-id\",\n \"origin-price\",\n \"premium\",\n \"price\",\n \"price[channel=B2B]\",\n \"price-additional-info\",\n \"price-ranges\",\n \"product-sku\",\n \"professional\",\n \"quantity\",\n \"shop-id\",\n \"shop-name\",\n \"shop-sku\",\n \"state-code\",\n \"total-price\",\n \"ongoing-discount-campaigns\"\n ],\n \"ongoing_discount_campaign_identifiers\": [\n \"1_JANUARY_PROMOTION_CAMPAIGN\",\n \"2_FEBRUARY_PROMOTION_CAMPAIGN\"\n ],\n \"shipping_zones\": [\n \"DOM1\"\n ],\n \"rename_fields\": {\n \"active\": \"active\",\n \"allow-quote-requests\": \"allowQuoteRequests\",\n \"available-end-date\": \"availableEndDate\",\n \"available-start-date\": \"availableStartDate\",\n \"channels\": \"channels\",\n \"currency-iso-code\": \"currencyIsoCode\",\n \"date-created\": \"dateCreated\",\n \"deleted\": \"deleted\",\n \"description\": \"description\",\n \"discount-end-date\": \"discountEndDate\",\n \"discount-price\": \"discountPrice\",\n \"discount-ranges\": \"discountRanges\",\n \"discount-start-date\": \"discountStartDate\",\n \"favorite-rank\": \"favoriteRank\",\n \"fulfillment-center-code\": \"fulfillmentCenterCode\",\n \"leadtime-to-ship\": \"leadtimeToShip\",\n \"logistic-class\": \"logisticClass\",\n \"measurement-units\": \"measurementUnits\",\n \"min-shipping-price\": \"minShippingPrice\",\n \"min-shipping-price-additional\": \"minShippingPriceAdditional\",\n \"min-shipping-type\": \"minShippingType\",\n \"min-shipping-zone\": \"minShippingZone\",\n \"offer-id\": \"offerId\",\n \"ongoing-discount-campaigns\": \"ongoingDiscountCampaigns\",\n \"origin-price\": \"originPrice\",\n \"premium\": \"premium\",\n \"price\": \"price\",\n \"price-additional-info\": \"priceAdditionalinfo\",\n \"price-ranges\": \"priceRanges\",\n \"product-sku\": \"productSku\",\n \"professional\": \"professional\",\n \"quantity\": \"quantity\",\n \"shop-id\": \"shopId\",\n \"shop-name\": \"shopName\",\n \"state-code\": \"stateCode\",\n \"total-price\": \"totalPrice\"\n },\n \"items_per_chunk\": 10000,\n \"megabytes_per_chunk\": 100\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OF53 - Poll the status of an asynchronous offer export (OF52)", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/export/async/status/:tracking_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "export", "async", "status", ":tracking_id" ], "variable" : [ { "key" : ":tracking_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "P11 - List offers for each given product", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/offers", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "offers" ], "variable" : null, "query" : [ { "key" : "product_ids", "value" : "", "disabled" : true }, { "key" : "product_references", "value" : "", "disabled" : true }, { "key" : "offer_state_codes", "value" : "", "disabled" : true }, { "key" : "all_offers", "value" : "", "disabled" : true }, { "key" : "channel_codes", "value" : "", "disabled" : true }, { "key" : "all_channels", "value" : "", "disabled" : true }, { "key" : "pricing_channel_code", "value" : "", "disabled" : true }, { "key" : "pricing_customer_organization_id", "value" : "", "disabled" : true }, { "key" : "shipping_zones", "value" : "", "disabled" : true }, { "key" : "all_shipping_zones", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "PRI01 - Import a price file", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/offers/pricing/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "pricing", "imports" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "file", "type" : "file", "contentType" : null, "value" : null, "description" : null } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "PRI02 - Get information and statistics about an offer pricing import", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/pricing/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "pricing", "imports" ], "variable" : null, "query" : [ { "key" : "import_id", "value" : "", "disabled" : true }, { "key" : "start_date", "value" : "", "disabled" : true }, { "key" : "end_date", "value" : "", "disabled" : true }, { "key" : "status", "value" : "", "disabled" : true }, { "key" : "origins", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "PRI03 - Get the error report for a price import in CSV format", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/pricing/imports/:import_id/error_report", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "pricing", "imports", ":import_id", "error_report" ], "variable" : [ { "key" : ":import_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "text/csv" } ], "body" : null }, "response" : [ ] }, { "name" : "STO01 - Import a stock file", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/offers/stock/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "stock", "imports" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "file", "type" : "file", "contentType" : null, "value" : null, "description" : null } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "STO02 - Get information and statistics about an offer stock import", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/stock/imports/:import_id/status", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "stock", "imports", ":import_id", "status" ], "variable" : [ { "key" : ":import_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "STO03 - Get the error report for a stock import in CSV format", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/stock/imports/:import_id/error_report", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "stock", "imports", ":import_id", "error_report" ], "variable" : [ { "key" : ":import_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "text/csv" } ], "body" : null }, "response" : [ ] } ] }, { "name" : "Orders", "item" : [ { "name" : "OR04 - Patch update orders", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"orders\": [\n {\n \"order_id\": \"Order_00014\",\n \"order_lines\": [\n {\n \"order_line_id\": \"Order_00014-A-1\",\n \"eco_contributions\": [\n {\n \"epr_category_code\": \"FR-DEEE\",\n \"producer_id\": \"123456789012345\",\n \"unit_amount\": 1.25\n },\n {\n \"epr_category_code\": \"FR-ASL\",\n \"producer_id\": \"FRASLPRODUCERID\",\n \"unit_amount\": 1.10\n }\n ]\n }\n ]\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR07 - Update order line shipping origin", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/shipping_from", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "shipping_from" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"order_lines\": [\n {\n \"id\": \"order-line-1\",\n \"shipping_from\" : {\n \"address\" : {\n \"city\": \"New York City\",\n \"country_iso_code\": \"USA\",\n \"state\": \"New York\",\n \"street_1\": \"113 MacDougal Street\",\n \"street_2\": \"1st floor\",\n \"zip_code\": \"NY 10012\"\n }\n }\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR11 - List orders with pagination", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/orders", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders" ], "variable" : null, "query" : [ { "key" : "order_ids", "value" : "", "disabled" : true }, { "key" : "order_references_for_customer", "value" : "", "disabled" : true }, { "key" : "order_references_for_seller", "value" : "", "disabled" : true }, { "key" : "order_state_codes", "value" : "", "disabled" : true }, { "key" : "channel_codes", "value" : "", "disabled" : true }, { "key" : "only_null_channel", "value" : "", "disabled" : true }, { "key" : "start_date", "value" : "", "disabled" : true }, { "key" : "end_date", "value" : "", "disabled" : true }, { "key" : "start_update_date", "value" : "", "disabled" : true }, { "key" : "end_update_date", "value" : "", "disabled" : true }, { "key" : "customer_debited", "value" : "", "disabled" : true }, { "key" : "payment_workflow", "value" : "", "disabled" : true }, { "key" : "has_incident", "value" : "", "disabled" : true }, { "key" : "fulfillment_center_code", "value" : "", "disabled" : true }, { "key" : "order_tax_mode", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OR13 - Export orders asynchronously", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/orders/async-export", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "async-export" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : " {\n \"channel_codes\": [\n \"US\"\n ],\n \"fulfillment_center_codes\": \"fulfillment_center_codes_001\",\n \"items_per_chunk\": 10000,\n \"megabytes_per_chunk\": 100,\n \"only_null_channel\": false,\n \"order_state_codes\": [\n \"WAITING_ACCEPTANCE\",\n \"SHIPPING\"\n ],\n \"order_tax_mode\": \"TAX_INCLUDED\",\n \"shop_ids\": [\n 2310\n ],\n \"start_date\": \"2022-01-01T00:00:00.000Z\",\n \"end_date\": \"2023-01-01T00:00:00.000Z\",\n \"start_update_date\": \"2019-08-20T14:58:22.460Z\",\n \"end_update_date\": \"2020-08-19T14:58:22.460Z\"\n }\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR14 - Get the status of an asynchronous order export.", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/orders/async-export/status/:tracking_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "async-export", "status", ":tracking_id" ], "variable" : [ { "key" : ":tracking_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OR21 - Accept or refuse order lines", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/accept", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "accept" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"order_lines\": [\n {\n \"accepted\": true,\n \"id\": \"Order_00012-B-1\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR23 - Update carrier tracking information for a specific order", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/tracking", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "tracking" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"carrier_code\": \"UPS\",\n \"carrier_standard_code\": \"UPS\",\n \"carrier_name\": \"UPS\",\n \"carrier_url\": \"https://ups.com\",\n \"tracking_number\": \"5555\"\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR24 - Validate the shipment of an order", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/ship", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "ship" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ ], "body" : null }, "response" : [ ] }, { "name" : "OR28 - Perform refunds on order lines", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/refund", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "refund" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"order_tax_mode\": \"TAX_EXCLUDED\",\n \"refunds\": [\n {\n \"amount\": 1.5,\n \"currency_iso_code\": \"USD\",\n \"excluded_from_shipment\": false,\n \"fees\": [\n {\n \"amount\": 0.50,\n \"code\": \"CARD_FEE\"\n },\n {\n \"amount\": 0.25,\n \"code\": \"EU_DRS\"\n }\n ],\n \"order_line_id\": \"Order_00010-A-1\",\n \"quantity\": 0,\n \"reason_code\": \"15\",\n \"shipping_amount\": 2,\n \"shipping_taxes\": [\n {\n \"amount\": \"1\",\n \"code\": \"tax1\"\n },\n {\n \"amount\": \"1\",\n \"code\": \"tax2\"\n }\n ],\n \"tax_legal_notice\": \"Tax legal notice\",\n \"taxes\": [\n {\n \"amount\": \"1\",\n \"code\": \"tax1\"\n },\n {\n \"amount\": \"1\",\n \"code\": \"tax2\"\n }\n ]\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR29 - Perform a full cancelation of an order", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/cancel", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "cancel" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ ], "body" : null }, "response" : [ ] }, { "name" : "OR30 - Perform cancelations on order lines", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/cancel", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "cancel" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"cancelations\": [\n {\n \"amount\": 2,\n \"currency_iso_code\": \"USD\",\n \"fees\": [\n {\n \"amount\": \"1\",\n \"code\": \"fee1\"\n },\n {\n \"amount\": \"1\",\n \"code\": \"fee2\"\n }\n ],\n \"order_line_id\": \"Order_00013-A-1\",\n \"quantity\": 0,\n \"reason_code\": 34,\n \"shipping_amount\": 0,\n \"shipping_taxes\": [\n {\n \"amount\": \"1\",\n \"code\": \"tax1\"\n },\n {\n \"amount\": \"1\",\n \"code\": \"tax2\"\n }\n ],\n \"taxes\": [\n {\n \"amount\": 1,\n \"code\": \"tax1\"\n },\n {\n \"amount\": 1,\n \"code\": \"tax2\"\n }\n ],\n \"fees\": [\n {\n \"amount\": 0.50,\n \"code\": \"CARD_FEE\"\n },\n {\n \"amount\": 0.25,\n \"code\": \"EU_DRS\"\n }\n ]\n }\n ],\n \"order_tax_mode\": \"TAX_EXCLUDED\"\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR31 - Update the custom fields of an order and its order lines", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/additional_fields", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "additional_fields" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"order_additional_fields\": [\n {\n \"code\": \"ecotax\",\n \"value\": [\n \"15\"\n ]\n }\n ],\n \"order_lines\": [\n {\n \"order_line_additional_fields\": [\n {\n \"code\": \"delivery-countries\",\n \"value\": [\n \"Canada\"\n ]\n }\n ],\n \"order_line_id\": \"Order_00014-A-1\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR32 - Adjust order line", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/adjust", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "adjust" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"order_lines\": [\n {\n \"order_line_id\": \"ORDER_0014-A-1\",\n \"actual_measurement\": 0.85\n },\n {\n \"order_line_id\": \"ORDER_9999-A-1\",\n \"actual_measurement\": 1\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR33 - Fully cancel a list of order lines of an order", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/orders/:order_id/cancel-order-lines", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "cancel-order-lines" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"order_lines\" : [\n {\n \"id\": \"Order_00013-A-1\",\n \"reason_code\": \"34\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "OR51 - Get the evaluation of an order", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/orders/:order_id/evaluation", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "evaluation" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OR72 - Lists order's documents", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/orders/documents", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "documents" ], "variable" : null, "query" : [ { "key" : "order_ids", "value" : "", "disabled" : false }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OR73 - Download one or multiple documents attached to one or multiple orders", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/orders/documents/download", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "documents", "download" ], "variable" : null, "query" : [ { "key" : "order_ids", "value" : "", "disabled" : true }, { "key" : "document_ids", "value" : "", "disabled" : true }, { "key" : "document_codes", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "OR74 - Upload documents to attach to an order", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/orders/:order_id/documents", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", ":order_id", "documents" ], "variable" : [ { "key" : ":order_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "files", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "order_documents", "type" : "text", "contentType" : "application/json", "value" : "{\n \"order_documents\": [\n {\n \"file_name\": \"filename1.txt\",\n \"type_code\": \"CUSTOMER_INVOICE\",\n \"entity\": null\n },\n {\n \"file_name\": \"return_label.pdf\",\n \"type_code\": \"SYSTEM_RETURN_LABEL\",\n \"entity\": {\n \"id\": \"c0703388-df01-41c8-8a03-bc797c93515f\",\n \"type\": \"RETURN\"\n }\n }\n ]\n}\n", "description" : "The list of documents to be uploaded details" } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "OR75 - List all the order taxes available on the platform", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/orders/taxes", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "taxes" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OR76 - Delete an order document", "request" : { "method" : "delete", "url" : { "raw" : "{{URL}}/api/orders/documents/:document_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "orders", "documents", ":document_id" ], "variable" : [ { "key" : ":document_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ ], "body" : null }, "response" : [ ] } ] }, { "name" : "Picklists", "item" : [ { "name" : "PL11 - List picklists", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/picklists", "host" : [ "{{URL}}" ], "path" : [ "", "api", "picklists" ], "variable" : null, "query" : [ { "key" : "pickrun_code", "value" : "", "disabled" : true }, { "key" : "pickup_date_min", "value" : "", "disabled" : true }, { "key" : "pickup_date_max", "value" : "", "disabled" : true }, { "key" : "picklist_id", "value" : "", "disabled" : true }, { "key" : "picklist_state", "value" : "", "disabled" : true }, { "key" : "order_line_id", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] } ] }, { "name" : "Platform Settings", "item" : [ { "name" : "AF01 - List all custom fields", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/additional_fields", "host" : [ "{{URL}}" ], "path" : [ "", "api", "additional_fields" ], "variable" : null, "query" : [ { "key" : "entities", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "CH11 - List all enabled channels", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/channels", "host" : [ "{{URL}}" ], "path" : [ "", "api", "channels" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "CUR01 - List currency codes and labels", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/currencies", "host" : [ "{{URL}}" ], "path" : [ "", "api", "currencies" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "DO01 - List all document types", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/documents", "host" : [ "{{URL}}" ], "path" : [ "", "api", "documents" ], "variable" : null, "query" : [ { "key" : "entities", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "L01 - List locale codes and labels", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/locales", "host" : [ "{{URL}}" ], "path" : [ "", "api", "locales" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "OF61 - List offer conditions", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/offers/states", "host" : [ "{{URL}}" ], "path" : [ "", "api", "offers", "states" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "PC01 - List platform configurations", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/platform/configuration", "host" : [ "{{URL}}" ], "path" : [ "", "api", "platform", "configuration" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "RE01 - List reasons", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/reasons", "host" : [ "{{URL}}" ], "path" : [ "", "api", "reasons" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "SH11 - List all active shipping zones", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipping/zones", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipping", "zones" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "SH12 - List all active shipping methods", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipping/types", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipping", "types" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "SH21 - List all carriers", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipping/carriers", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipping", "carriers" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "SH31 - List all logistic classes", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipping/logistic_classes", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipping", "logistic_classes" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "SH42 - Get shop shipping configuration", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipping/configuration/shop", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipping", "configuration", "shop" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "SH52 - Get shipping charges configured for a shop account", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shipping/charges/shop", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shipping", "charges", "shop" ], "variable" : null, "query" : [ { "key" : "overridden_by_shop", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "V01 - Health Check endpoint", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/version", "host" : [ "{{URL}}" ], "path" : [ "", "api", "version" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ ], "body" : null }, "response" : [ ] } ] }, { "name" : "Products", "item" : [ { "name" : "H11 - List Catalog categories (parents and children) related to a Catalog category", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/hierarchies", "host" : [ "{{URL}}" ], "path" : [ "", "api", "hierarchies" ], "variable" : null, "query" : [ { "key" : "hierarchy", "value" : "", "disabled" : true }, { "key" : "max_level", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "P31 - Get products for a list of product references", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products" ], "variable" : null, "query" : [ { "key" : "product_references", "value" : "", "disabled" : false }, { "key" : "products", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "P41 - Import products to the operator information system", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/products/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "conversion_options", "type" : "text", "contentType" : null, "value" : null, "description" : "Options used for product file conversion when conversion_type is AI_CONVERTER" }, { "key" : "conversion_type", "type" : "text", "contentType" : null, "value" : null, "description" : "Product file conversion type. If Catalog Transformer is enabled but the conversionType is not specified, then the default configuration from the shop settings will be used" }, { "key" : "file", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "operator_format", "type" : "text", "contentType" : null, "value" : null, "description" : "Force the use of the operator product format" } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "P42 - Get the import status for a product import", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/imports/:import", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports", ":import" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "P44 - Get the error report file for a product import (\"Non-integrated products report\")", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/imports/:import/error_report", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports", ":import", "error_report" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "P45 - Get the product integration report file for a product import (\"Added products report\")", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/imports/:import/new_product_report", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports", ":import", "new_product_report" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "P46 - Get the transformed file for a product import (\"File in operator format\")", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/imports/:import/transformed_file", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports", ":import", "transformed_file" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "text/csv" } ], "body" : null }, "response" : [ ] }, { "name" : "P47 - Get the transformation error report file for a product import (\"Source file error report\")", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/imports/:import/transformation_error_report", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports", ":import", "transformation_error_report" ], "variable" : [ { "key" : ":import", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "P51 - Get information about product import statuses", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/imports", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "imports" ], "variable" : null, "query" : [ { "key" : "last_request_date", "value" : "", "disabled" : true }, { "key" : "status", "value" : "", "disabled" : true }, { "key" : "has_transformed_file", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "PM11 - Get the product attribute configuration", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/products/attributes", "host" : [ "{{URL}}" ], "path" : [ "", "api", "products", "attributes" ], "variable" : null, "query" : [ { "key" : "hierarchy", "value" : "", "disabled" : true }, { "key" : "max_level", "value" : "", "disabled" : true }, { "key" : "all_operator_attributes", "value" : "", "disabled" : true }, { "key" : "with_roles", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "VL11 - Get information about operator's value lists", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/values_lists", "host" : [ "{{URL}}" ], "path" : [ "", "api", "values_lists" ], "variable" : null, "query" : [ { "key" : "code", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] } ] }, { "name" : "Promotions", "item" : [ { "name" : "PR01 - List promotions", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/promotions", "host" : [ "{{URL}}" ], "path" : [ "", "api", "promotions" ], "variable" : null, "query" : [ { "key" : "ids", "value" : "", "disabled" : true }, { "key" : "types", "value" : "", "disabled" : true }, { "key" : "states", "value" : "", "disabled" : true }, { "key" : "ending_after", "value" : "", "disabled" : true }, { "key" : "starting_before", "value" : "", "disabled" : true }, { "key" : "date_created_from", "value" : "", "disabled" : true }, { "key" : "date_created_to", "value" : "", "disabled" : true }, { "key" : "last_request_date", "value" : "", "disabled" : true }, { "key" : "locale", "value" : "", "disabled" : true }, { "key" : "trigger_offer_ids", "value" : "", "disabled" : true }, { "key" : "reward_offer_ids", "value" : "", "disabled" : true }, { "key" : "channel_codes", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "PR03 - Create a promotion", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/promotions", "host" : [ "{{URL}}" ], "path" : [ "", "api", "promotions" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"internal_description\": \"Summer sale event\",\n \"internal_id\": \"SUMMERSALE_3\",\n \"start_date\": \"2023-04-03T16:18:59.922Z\",\n \"end_date\": \"2023-08-30T22:00:00.000Z\",\n \"application_to_cart\": [\n {\n \"promo_code\": \"SUMMER20\"\n }\n ],\n \"channel_codes\": [\n \"US\"\n ],\n \"customer_group_ids\": [\n \"Group2\"\n ],\n \"customer_organization_ids\": [\n \"Org1\"\n ],\n \"trigger\": {\n \"quantity_purchased\": 1,\n \"same_item_purchased\": false,\n \"type\": \"EVERY_QUANTITY\",\n \"selection\": {\n \"type\": \"ALL\"\n }\n },\n \"reward\": {\n \"percentage_off\": 10.00,\n \"max_quantity_to_discount\": 1,\n \"type\": \"PERCENTAGE_OFF\",\n \"selection\": {\n \"type\": \"BRAND\",\n \"values\": [\n \"Samsung\",\n \"Belkin\"\n ]\n }\n },\n \"public_descriptions\": [\n {\n \"locale\": \"en_US\",\n \"value\": \"Summer promotions\"\n },\n {\n \"locale\": \"fr_FR\",\n \"value\": \"Promotions d'été\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "PR04 - Update a promotion", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/promotions/:promotion_internal_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "promotions", ":promotion_internal_id" ], "variable" : [ { "key" : ":promotion_internal_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"internal_description\": \"Summer sale event\",\n \"start_date\": \"2023-04-03T16:18:59.922Z\",\n \"end_date\": \"2023-08-30T22:00:00.000Z\",\n \"application_to_cart\": [\n {\n \"promo_code\": \"SUMMER20\"\n }\n ],\n \"channel_codes\": [\n \"US\"\n ],\n \"customer_group_ids\": [\n \"Group2\"\n ],\n \"customer_organization_ids\": [\n \"Org1\"\n ],\n \"trigger\": {\n \"selection\": {\n \"type\": \"ALL\"\n }\n },\n \"reward\": {\n \"selection\": {\n \"type\": \"BRAND\",\n \"values\": [\n \"Samsung\",\n \"Belkin\"\n ]\n }\n },\n \"public_descriptions\": [\n {\n \"locale\": \"en_US\",\n \"value\": \"Summer promotions\"\n },\n {\n \"locale\": \"fr_FR\",\n \"value\": \"Promotions d'été\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] } ] }, { "name" : "Returns", "item" : [ { "name" : "RT01 - Create returns", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/returns", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"accepted\": null,\n \"reason_code\": \"RETURN_CHANGED_MIND\",\n \"method_code\": \"RETURN_METHOD_BY_MAIL\",\n \"order_commercial_id\": \"ORDER-001\",\n \"return_lines\": [\n {\n \"order_line_id\": \"ORDER-001-A-1\",\n \"quantity\": 1\n },\n {\n \"order_line_id\": \"ORDER-001-B-2\",\n \"quantity\": 2\n }\n ],\n \"rma\": \"RETURN_RMA\",\n \"label_url\":\"https://www.label-url.com\"\n },\n {\n \"accepted\": true,\n \"reason_code\": \"RETURN_CHANGED_MIND\",\n \"method_code\": \"RETURN_METHOD_DROP_OFF_POINT\",\n \"order_commercial_id\": \"ORDER-DROPSHIP-1\",\n \"return_lines\": [\n {\n \"order_line_id\": \"ORDER-DROPSHIP-1-A-1\",\n \"quantity\": 1\n }\n ],\n \"rma\": null,\n \"label_url\": null,\n \"description\": \"Description of return\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT04 - Patch update returns", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/returns", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"id\": \"f61b5db8-d8f5-4715-b05f-aa4432c0e9e2\",\n \"tracking\": {\n \"tracking_url\": \"https://www.tracking.com\"\n }\n },\n {\n \"id\": \"c91b5db8-d8f5-4715-b05f-aa4432c0e989\",\n \"tracking\": {\n \"tracking_url\": \"https://invalid_url\"\n }\n },\n {\n \"id\": \"2dc4f7d7\",\n \"tracking\": {\n \"tracking_url\": \"https://www.tracking.com\"\n }\n },\n {\n \"id\": \"21456f96-19ef-4f34-97be-6cf937755f01\",\n \"rma\": \"RETURN_RMA\"\n },\n {\n \"id\": \"2dc4f7d7-da59-4588-bec7-ce62daab2f93\",\n \"tracking\": {\n \"tracking_url\": \"https://www.tracking.com\",\n \"carrier_name\": \"customCarrier\",\n \"tracking_number\": \"1H79D0K76\"\n },\n \"rma\": \"RETURN_RMA\",\n \"label_url\": \"https://www.label-url.com\"\n },\n {\n \"id\": \"1716be7a-93f0-4242-b55b-fff05a76d168\",\n \"tracking\": {\n \"tracking_number\": \"6HD869420\",\n \"carrier_code\": \"UPS\"\n },\n \"rma\": \"RETURN_RMA\",\n \"label_url\": \"https://www.label-url.com\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT11 - List returns", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/returns", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns" ], "variable" : null, "query" : [ { "key" : "return_id", "value" : "", "disabled" : true }, { "key" : "return_state", "value" : "", "disabled" : true }, { "key" : "return_creation_date_from", "value" : "", "disabled" : true }, { "key" : "return_creation_date_to", "value" : "", "disabled" : true }, { "key" : "return_last_updated_from", "value" : "", "disabled" : true }, { "key" : "return_last_updated_to", "value" : "", "disabled" : true }, { "key" : "order_commercial_id", "value" : "", "disabled" : true }, { "key" : "order_line_id", "value" : "", "disabled" : true }, { "key" : "return_rma", "value" : "", "disabled" : true }, { "key" : "customer_id", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "RT12 - List items to return", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/returns/items_to_return", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "items_to_return" ], "variable" : null, "query" : [ { "key" : "order_commercial_id", "value" : "", "disabled" : true }, { "key" : "order_line_id", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "RT21 - Accept or refuse a return request", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/returns/accept", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "accept" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"id\": \"af1a537d-3f8a-4bb4-a69c-08df8395ece6\",\n \"accepted\": true\n },\n {\n \"id\": \"b77907cb-f72e-4f69-aac3-14df566311de\",\n \"accepted\": false,\n \"rejection_reason_code\": \"RETURN_REJECTION_NOT_ELIGIBLE\"\n },\n {\n \"id\": \"df7b1144-0789-46f9-a0db-bb79c2c7de3a\",\n \"accepted\": true\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT25 - Validate returns as received", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/returns/receive", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "receive" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"id\": \"af1a537d-3f8a-4bb4-a69c-08df8395ece6\"\n },\n {\n \"id\": \"df7b1144-0789-46f9-a0db-bb79c2c7de3a\"\n },\n {\n \"id\": \"b77907cb-f72e-4f69-aac3-14df566311de\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT26 - Mark a return as compliant or non compliant", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/returns/compliance", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "compliance" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"id\": \"f61b5db8-d8f5-4715-b05f-aa4432c0e9e2\",\n \"return_lines\": [\n {\n \"order_line_id\": \"OR01-A-1\",\n \"compliant\": true\n },\n {\n \"order_line_id\": \"OR01-A-2\",\n \"compliant\": false,\n \"non_compliance_reason_code\": \"RETURN_NON_COMPLIANT_MISSING_ITEM\",\n \"non_compliance_additional_info\": \"There is a missing item\"\n }\n ]\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT27 - Mark a return as closed", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/returns/close", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "close" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"id\": \"af1a537d-3f8a-4bb4-a69c-08df8395ece6\"\n },\n {\n \"id\": \"df7b1144-0789-46f9-a0db-bb79c2c7de3a\"\n },\n {\n \"id\": \"b77907cb-f72e-4f69-aac3-14df566311de\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT29 - Mark a return as canceled", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/returns/cancel", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "cancel" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"returns\": [\n {\n \"id\": \"af1a537d-3f8a-4bb4-a69c-08df8395ece6\"\n },\n {\n \"id\": \"df7b1144-0789-46f9-a0db-bb79c2c7de3a\"\n },\n {\n \"id\": \"b77907cb-f72e-4f69-aac3-14df566311de\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT51 - Create return labels", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/returns/return-labels", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "return-labels" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"return_labels\": [\n {\n \"return_id\": \"6c074a94-e9b5-42ea-afc3-e4d5198fa679\",\n \"package\": {\n \"weight\": {\n \"value\": 1.5,\n \"unit\": \"kg\"\n },\n \"dimensions\": {\n \"length\": 30,\n \"width\": 20,\n \"height\": 15,\n \"unit\": \"cm\"\n }\n },\n \"label_selection_mode\": \"CHEAPEST\",\n \"carrier_code\": null,\n \"carrier_service_code\": null,\n \"label_options\": {\n \"qr_code\": false\n },\n \"shipping_from\": {\n \"street_1\": \"123 High Street\",\n \"street_2\": null,\n \"city\": \"London\",\n \"state\": null,\n \"zip_code\": \"SW1A 1AA\",\n \"country_iso_code\": \"GB\",\n \"contact_name\": \"Store Manager\",\n \"contact_phone\": \"+44 20 1234 5678\"\n }\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "RT52 - List return labels", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/returns/return-labels", "host" : [ "{{URL}}" ], "path" : [ "", "api", "returns", "return-labels" ], "variable" : null, "query" : [ { "key" : "return_id", "value" : "", "disabled" : true }, { "key" : "label_state", "value" : "", "disabled" : true }, { "key" : "date_created_from", "value" : "", "disabled" : true }, { "key" : "date_created_to", "value" : "", "disabled" : true }, { "key" : "last_updated_from", "value" : "", "disabled" : true }, { "key" : "last_updated_to", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] } ] }, { "name" : "Stores", "item" : [ { "name" : "A01 - Get shop information", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/account", "host" : [ "{{URL}}" ], "path" : [ "", "api", "account" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "A02 - Update shop information", "request" : { "method" : "put", "url" : { "raw" : "{{URL}}/api/account", "host" : [ "{{URL}}" ], "path" : [ "", "api", "account" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "application/json" } ], "body" : { "raw" : "{\n \"address\": {\n \"city\": \"New York\",\n \"civility\": \"Mr\",\n \"country\": \"USA\",\n \"firstname\": \"Doe\",\n \"lastname\": \"John\",\n \"phone\": \"213-509-6996\",\n \"phone_secondary\": \"213-509-6995\",\n \"state\": \"Manhattan\",\n \"street1\": \"30, Prince Street\",\n \"street2\": \"1st floor\",\n \"zip_code\": \"NY 10012\"\n },\n \"return_policy\": \"3 days return policy\",\n \"producer_identifiers\": [\n {\n \"epr_category_code\": \"FR-DEA\",\n \"producer_id\": \"FR123456_89ABCD\"\n },\n {\n \"epr_category_code\": \"DE-WEEE\",\n \"producer_id\": \"PRODUCERID1\"\n }\n ],\n \"recycling_policy\": \"When we deliver your new item,we’ll take your old one away for you.Appliance recycling:this service is available through our home delivery service.Recycling electronic items in-store:if you have an old electronic item,we can safely recycle these items in-store,for free\",\n \"shipping_country\": \"ITA\",\n \"channels\": [\n \"US\"\n ],\n \"closed_from\": \"2025-03-20T16:42:21Z\",\n \"closed_to\": \"2026-03-20T16:42:21Z\",\n \"description\": \"This is the description of this seller\",\n \"shop_name\": \"My Super Seller\",\n \"web_site\": \"https://example.fr\",\n \"fax\": \"0245875499\",\n \"email\": \"my-store@example.com\",\n \"is_professional\": true,\n \"pro_details\": {\n \"corporate_name\": \"Mirakl Inc.\",\n \"identification_number\": \"44268625900078\",\n \"tax_identification_number\": \"FR939383\"\n },\n \"payment_info\": {\n \"@type\": \"IBAN\",\n \"bank_name\": \"CACE\",\n \"bic\": \"AGRIFRPPXX2\",\n \"iban\": \"FR6031047696713027315572590\",\n \"owner\": \"John Doe\"\n },\n \"shop_additional_fields\": [\n {\n \"code\": \"segment\",\n \"value\": \"1\"\n },\n {\n \"code\": \"prio-level\",\n \"value\": \"High\"\n }\n ]\n}\n", "mode" : "raw" } }, "response" : [ ] }, { "name" : "A21 - Get shop statistics", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/account/statistics", "host" : [ "{{URL}}" ], "path" : [ "", "api", "account", "statistics" ], "variable" : null, "query" : [ { "key" : "periods", "value" : "", "disabled" : true }, { "key" : "channel_code", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "S30 - List shop's documents", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shops/documents", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shops", "documents" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] }, { "name" : "S31 - Download documents for one or multiple shops", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/shops/documents/download", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shops", "documents", "download" ], "variable" : null, "query" : [ { "key" : "document_ids", "value" : "", "disabled" : true }, { "key" : "type_codes", "value" : "", "disabled" : true }, { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/octet-stream" } ], "body" : null }, "response" : [ ] }, { "name" : "S32 - Upload business documents to associate with a shop", "request" : { "method" : "post", "url" : { "raw" : "{{URL}}/api/shops/documents", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shops", "documents" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" }, { "key" : "Content-Type", "value" : "multipart/form-data" } ], "body" : { "formdata" : [ { "key" : "files", "type" : "file", "contentType" : null, "value" : null, "description" : null }, { "key" : "shop_documents", "type" : "text", "contentType" : "application/json", "value" : "{\n \"shop_documents\": [\n {\n \"file_name\": \"filename1.txt\",\n \"type_code\": \"PASSPORT\"\n },\n {\n \"file_name\": \"filename2.txt\"\n \"type_code\": \"ID_DOCUMENT\"\n }\n ]\n}\n", "description" : "A descriptor associated to the files" } ], "mode" : "formdata" } }, "response" : [ ] }, { "name" : "S33 - Delete a shop document", "request" : { "method" : "delete", "url" : { "raw" : "{{URL}}/api/shops/documents/:document_id", "host" : [ "{{URL}}" ], "path" : [ "", "api", "shops", "documents", ":document_id" ], "variable" : [ { "key" : ":document_id", "value" : "value" } ], "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ ], "body" : null }, "response" : [ ] } ] }, { "name" : "Users", "item" : [ { "name" : "RO02 - List shop roles", "request" : { "method" : "get", "url" : { "raw" : "{{URL}}/api/users/shops/roles", "host" : [ "{{URL}}" ], "path" : [ "", "api", "users", "shops", "roles" ], "variable" : null, "query" : [ { "key" : "shop_id", "value" : "", "disabled" : true } ] }, "headers" : [ { "key" : "Accept", "value" : "application/json" } ], "body" : null }, "response" : [ ] } ] } ], "auth" : { "type" : "apikey", "bearer" : null, "apikey" : [ { "key" : "value", "value" : "{{SHOP_KEY}}", "type" : "string" }, { "key" : "key", "value" : "Authorization", "type" : "string" } ] } }