{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.dotcon.io" } ], "info": { "name": "Dotcon API", "_postman_id": "8f737802-96d9-4959-81f5-ef9cb9f5a180", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Allegro orders management", "description": "", "item": [ { "name": "Getting new orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-new-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-new-orders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all Allegro new orders and \"request_id\". We recommend that you save\n\"request_id\" and send it back to us using the \"confirm-orders\u201d method. This will confirm\nthat you have received the orders and you will not receive the same orders again.\n\nPlease note, that order_id field is unique in Allegro (for same merchant), if you get\nsame order_id - this means there is no new order, but changes in same order.\n\nIn this link you can check example of a complete order:\nLink to example<\/a>" }, "response": [ { "header": [], "code": 200, "body": "{\n\"request_id\": 1234,\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"12345678-a123-12ab-1234-123456789abc\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"sku\": \"12345\",\n \"ean\": \"ABCDEFGHI\",\n \"product_name\": \"ABCDEFGHI\",\n \"offer_id\": 12345678,\n \"offer_name\": \"Name\",\n \"quantity\": \"1\",\n \"price_amount\": \"10\",\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no new orders" } ] }, { "name": "Getting not fulfilled orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-not-fulfilled-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-not-fulfilled-orders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all not fulfilled orders." }, "response": [ { "header": [], "code": 200, "body": "{\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"12345678-a123-12ab-1234-123456789abc\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"sku\": \"12345\",\n \"ean\": \"ABCDEFGHI\",\n \"product_name\": \"ABCDEFGHI\",\n \"offer_id\": 12345678,\n \"offer_name\": \"Name\",\n \"quantity\": \"1\",\n \"price_amount\": \"10\",\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no not fulfilled orders" } ] }, { "name": "Getting order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-order\/:order_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-order\/:order_id", "variable": [ { "id": "order_id", "key": "order_id", "value": "12345678-a123-12ab-1234-123456789abc", "description": "The id of the order is required." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns the order by order_id." }, "response": [ { "header": [], "code": 200, "body": "{\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"12345678-a123-12ab-1234-123456789abc\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"sku\": \"12345\",\n \"ean\": \"ABCDEFGHI\",\n \"product_name\": \"ABCDEFGHI\",\n \"offer_id\": 12345678,\n \"offer_name\": \"Name\",\n \"quantity\": \"1\",\n \"price_amount\": \"10\",\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "is no order with provided order id" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"order_id\": [\n \"The order id format is invalid.\"\n ]\n}\n}", "name": "given data was invalid" } ] }, { "name": "Confirmation of receiving new orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-confirm-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-confirm-orders" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"request_id\":\"1234\"}" }, "description": "This method confirms you received the orders. You need to send us\nthe \"request_id\", which you received after using the method \"allegro-new-orders\".\nIt will confirm you received the orders, and you will\nnot receive the same orders again next time." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Data was received successfully.\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"request_id\": [\n \"The request id must be between 1 and 10 digits.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "the selected request id already confirmed or does not exist" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n \"errors\": \"Provided request_id was incorrect\"\n}", "name": "request_id was incorrect" } ] }, { "name": "Sending orders tracking information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-send-order-tracking", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-send-order-tracking" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order_id\":\"12345678-a123-12ab-1234-123456789abc\",\"shipment_carrier\":\"Name\",\"tracking\":\"123456789\",\"shipping_from_warehouse\":\"ABC\"}" }, "description": "By this method, you can fill in and share the order tracking information." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Tracking information received successfully.\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"order_id\": [\n \"The selected order id is invalid.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"errors\": \"Tracking information already exist.\"\n}", "name": "already exist" }, { "header": [], "code": 422, "body": "{\n\"errors\": \"Order already fulfilled.\"\n}", "name": "already exist" } ] }, { "name": "Getting orders by date", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-orders\/:year\/:month\/:day", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-orders\/:year\/:month\/:day", "variable": [ { "id": "year", "key": "year", "value": "2022", "description": "Year is required and will return orders for the selected year." }, { "id": "month", "key": "month", "value": "1", "description": "Month is required and will return orders for the selected month." }, { "id": "day", "key": "day", "value": "7", "description": "optional Day is optional and will return orders for the selected day of the given month and year." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all Allegro orders\nfor the selected year and month.\nIt is not possible to receive information older than 2 years." }, "response": [ { "header": [], "code": 200, "body": "{\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"12345678-a123-12ab-1234-123456789abc\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"sku\": \"12345\",\n \"ean\": \"ABCDEFGHI\",\n \"product_name\": \"ABCDEFGHI\",\n \"offer_id\": 12345678,\n \"offer_name\": \"Name\",\n \"quantity\": \"1\",\n \"price_amount\": \"10\",\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no orders for this date" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"year\": [\n \"The year must be 4 digits.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"month\": [\n \"The month must be number greater than 0 and less than 13.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"day\": [\n \"The day must be between 1 and 31.\"\n ]\n}\n}", "name": "invalid day" } ] } ] }, { "name": "Assortment\/Stock management", "description": "", "item": [ { "name": "Uploading files", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/upload-feed", "query": [], "raw": "{{baseUrl}}\/api\/v1\/upload-feed" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "Stock", "src": [], "type": "file" } ] }, "description": "When uploading a file, we recommend saving the\n\"file-id\". The \"file-id\" will be\nrequired using the method \"file-status\" to request\nthe report of the upload status and errors.\nThe value of the \"name\" should be \"Stock\" or \"Product\". The \"content\" must be an information from CSV file in a form of string.\nWe recommend using \"file_get_contents\" or \"fopen\" functions in PHP and equivalents in other programming languages.\nAdditionally, the \"filename\" parameter in the multipart request is recommended to preserve the original file name.\n\nIn this link, you can check how we recommend using this method in PHP programming language:\nLink to example<\/a>\n\nIn this link, you can check the detailed file specification in Lithuanian language:\nLink to specification<\/a>\n\nIn this link, you can check the detailed file specification in English language:\nLink to specification<\/a>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"File saved successfully.\",\n \"file_id\": 123\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Incorrect file name.\"\n}", "name": "wrong name" }, { "header": [], "code": 422, "body": "{\n \"message\": \"File is empty.\"\n}", "name": "empty file" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The file does not have a field \"field name\".\"\n}", "name": "empty file" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Incorrect file format.\"\n}", "name": "incorrect file format" } ] }, { "name": "Checking file status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/file-status\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/file-status\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The \"file_id\" that was provided in \"upload-feed\" response." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "We recommend checking the status of the file not often than hourly. The final status is \"Done\". Any other status indicates\nthat the upload or processing is not yet completed. All\nprocessing status options and errors are in the \"Example request\" section on the right." }, "response": [ { "header": [], "code": 200, "body": "{\n\"file_type\": \"Products\",\n\"status\": \"File saved successfully\",\n\"created_at\": \"2022-01-13T12:35:23.000000Z\",\n\"updated_at\": \"2022-01-13T12:35:23.000000Z\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 404, "body": "{\n \"message\": \"File with this id does not exist.\"\n}", "name": "id does not exist" } ] } ] }, { "name": "Authentication management", "description": "", "item": [ { "name": "Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/login", "query": [], "raw": "{{baseUrl}}\/api\/v1\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"john_smith\",\"password\":\"SecretPwd123!@x\"}" }, "description": "This method returns authentication token.\nThe token will expire after 60 minutes.\n\nBefore trying to login for the first time, you must change your password, you can do this by clicking this link:\n\nLink to change password<\/a>", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 201, "body": "{\n \"user\": \"Name\",\n \"token\": \"264|C1HGT4kiOvEeGkUiqQBJfWXiNfmFLoiFgYmkNo7O\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\"\n\"errors\": {\n \"name\": [\n \"The selected name is invalid.\"\n ]\n}\n}", "name": "name not found" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\"\n\"errors\": {\n \"name\": [\n \"The name must be a string.\",\n \"A name is required\"\n ]\n}\n}", "name": "name is missing" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Bad credentials\"\n}", "name": "wrong password" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 201, "body": "{\n \"message\": \"logged out\"\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" } ] } ] }, { "name": "File upload management", "description": "", "item": [ { "name": "Uploading VAT Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/:platform\/upload-vat-invoice", "query": [], "raw": "{{baseUrl}}\/api\/v1\/:platform\/upload-vat-invoice", "variable": [ { "id": "platform", "key": "platform", "value": "allegro", "description": "Currently, only the \"allegro\" platform is supported. Allowed values: \"allegro\"." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "order_id", "value": "31e88c80-a380-11ef-aaa8-ad165b9e76d3", "type": "text" }, { "key": "invoice_number", "value": "AB-AB-ABC-1234-1234567", "type": "text" }, { "key": "vat_invoice", "src": [], "type": "file" } ] }, "description": "Upload a VAT invoice file for a specific order.\n\nCurrently, only the \"allegro\" platform is supported.\nEach order can have only one VAT invoice.\nOnly PDF files are accepted.\nThe file cannot be empty.\nThe order must exist in the system.\nIf a VAT invoice for the order already exists, the upload will be rejected.\n\nThe key-value pairs of the first associative array should look like this:\n\n'name' => 'order_id', (order_id is a string).\n\n'contents' => '31e88c80-a380-11ef-aaa8-ad165b9e76d3', (unique id of order whose VAT Invoice file you will send).\n\n The key-value pairs of the second associative array should look like this:\n\n'name' => 'invoice_number', (invoice_number is a string).\n\n'contents' => 'AB-AB-ABC-1234-1234567', (unique invoice number).\n\nThe key-value pairs of the third associative array should look like this:\n\n'name' => 'vat_invoice', (vat_invoice is a string).\n\n'contents' => fopen($pdfFilePath, 'r'), (content of VAT Invoice file in pdf format).\n\n'filename' => basename($pdfFilePath), (provided name of the file).\n\nIn this link you can check how we recommend using this method in PHP programming language:\nLink to example<\/a>" }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"File saved successfully.\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "unauthenticated" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Unsupported platform: allegro\"\n}", "name": "unsupported platform" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Missing field: order_id\"\n}", "name": "missing order_id" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Cannot upload VAT invoice: order id: 123-4567890-9876543 does not exist for platform allegro.\"\n}", "name": "order not found" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Missing field: invoice_number\"\n}", "name": "missing invoice_number" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Invalid invoice_number length\"\n}", "name": "invalid invoice_number" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Missing file in upload.\"\n}", "name": "missing file" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Incorrect file format (only PDF allowed).\"\n}", "name": "invalid file format" }, { "header": [], "code": 422, "body": "{\n \"message\": \"File is empty.\"\n}", "name": "empty file" }, { "header": [], "code": 422, "body": "{\n \"message\": \"VAT invoice for order 123-4567890-9876543 has already been uploaded.\"\n}", "name": "duplicate upload" } ] } ] }, { "name": "Orders management", "description": "", "item": [ { "name": "Getting new orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/new-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/new-orders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all new orders and \"request_id\". We recommend that you save\n\"request_id\" and send it back to us using the \"confirm-orders\u201d method. This will confirm\nthat you have received the orders and you will not receive the same orders again.\n\nPlease note, that order_id field is unique in Amazon (for same merchant), if you get\nsame order_id - this means there is no new order, but changes in same order.\nFor example, if customer requested cancelation, then you will receive this order update\nalong with all new orders, and \"is_buyer_requested_cancelation\" field will be set to \"TRUE\".\n\nIn this link you can check example of a complete order:\nLink to example<\/a>" }, "response": [ { "header": [], "code": 200, "body": "{\n\"request_id\": 1234,\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"012-0123456-0123456\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"sku\": \"12345\",\n \"product_name\": \"ABCDEFGHI\",\n \"quantity_purchased\": 1,\n \"currency\": \"ABC\",\n \"item_price\": \"123.12\"\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no new orders" } ] }, { "name": "Getting order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/order\/:order_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/order\/:order_id", "variable": [ { "id": "order_id", "key": "order_id", "value": "123-1234567-1234567", "description": "The id of the order is required." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns the order by order_id." }, "response": [ { "header": [], "code": 200, "body": "{\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"012-0123456-0123456\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"order_item_id\": \"01234567890123\",\n \"sku\": \"12345\",\n \"product_name\": \"ABCDEFGHI\",\n \"quantity_purchased\": 1,\n \"currency\": \"ABC\",\n \"item_price\": \"123.12\"\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "is no order with provided order id" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"order_id\": [\n \"The order id format is invalid.\"\n ]\n}\n}", "name": "given data was invalid" } ] }, { "name": "Confirmation of receiving new orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/confirm-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/confirm-orders" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"request_id\":\"1234\"}" }, "description": "This method confirms you received the orders. You need to send us\nthe \"request_id\", which you received after using the method \"new-orders\".\nIt will confirm you received the orders, and you will\nnot receive the same orders again next time." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Data was received successfully.\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"request_id\": [\n \"The request id must be between 1 and 10 digits.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "the selected request id already confirmed or does not exist" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n \"errors\": \"Provided request_id was incorrect\"\n}", "name": "request_id was incorrect" } ] }, { "name": "Sending orders tracking information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/send-order-tracking", "query": [], "raw": "{{baseUrl}}\/api\/v1\/send-order-tracking" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"order_id\":\"123-1234567-1234567\",\"shipment_carrier\":\"Name\",\"tracking\":\"123456789\",\"shipping_from_warehouse\":\"ABC\"}" }, "description": "By this method, you can fill in and share the order tracking information." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Tracking information received successfully.\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"order_id\": [\n \"The selected order id is invalid.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"errors\": \"Tracking information already exist.\"\n}", "name": "already exist" }, { "header": [], "code": 422, "body": "{\n\"errors\": \"Order already fulfilled.\"\n}", "name": "already exist" } ] }, { "name": "Getting not fulfilled orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/not-fulfilled-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/not-fulfilled-orders" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all not fulfilled orders." }, "response": [ { "header": [], "code": 200, "body": "{\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"012-0123456-0123456\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"order_item_id\": \"01234567890123\",\n \"sku\": \"12345\",\n \"product_name\": \"ABCDEFGHI\",\n \"quantity_purchased\": 1,\n \"currency\": \"ABC\",\n \"item_price\": \"123.12\"\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no not fulfilled orders" } ] }, { "name": "Getting orders by date", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/:year\/:month\/:day", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders\/:year\/:month\/:day", "variable": [ { "id": "year", "key": "year", "value": "2022", "description": "Year is required and will return orders for the selected year." }, { "id": "month", "key": "month", "value": "1", "description": "Month is required and will return orders for the selected month." }, { "id": "day", "key": "day", "value": "7", "description": "optional Day is optional and will return orders for the selected day of the given month and year." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all orders\nfor the selected year and month.\nIt is not possible to receive information older than 2 years.\nAccording to Amazon's data retention policy, orders older than 30 days will not contain personally identifiable information." }, "response": [ { "header": [], "code": 200, "body": "{\n\"orders\": [\n{\n \"marketplace_id\": \"AB\",\n \"order_id\": \"012-0123456-0123456\",\n \"status\": \"new\",\n \"fba\": 0,\n \"shipment_carrier\": \"NULL\",\n \"tracking\": \"NULL\",\n Other order information...\n {\n \"order_item_id\": \"01234567890123\",\n \"sku\": \"12345\",\n \"product_name\": \"ABCDEFGHI\",\n \"quantity_purchased\": 1,\n \"currency\": \"ABC\",\n \"item_price\": \"123.12\"\n Other order item information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no orders for this date" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"year\": [\n \"The year must be 4 digits.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"month\": [\n \"The month must be number greater than 0 and less than 13.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"day\": [\n \"The day must be between 1 and 31.\"\n ]\n}\n}", "name": "invalid day" } ] } ] }, { "name": "Reports management", "description": "", "item": [ { "name": "Getting report", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/report-request\/:report_type", "query": [], "raw": "{{baseUrl}}\/api\/v1\/report-request\/:report_type", "variable": [ { "id": "report_type", "key": "report_type", "value": "FBA_MYI_UNSUPPRESSED_INVENTORY_DATA", "description": "The report_type is required." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method retrieves information of latest available report for the specified report type.\nCurrently, the supported report type is FBA_MYI_UNSUPPRESSED_INVENTORY_DATA.\nThe response includes report information in JSON format, including the report filename and its timestamp." }, "response": [ { "header": [], "code": 200, "body": "{\n[\n {\n \"file_name\": \"2025-06-01-FBA_MYI_UNSUPPRESSED_INVENTORY_DATA_EU.txt\",\n \"timestamp\": \"2025-06-03 00:51:24\",\n \"content\": report information in JSON format,\n \"region\": EU,\n }\n]", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "is no report with provided report_type" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"report_type\": [\n \"The provided report type is invalid.\"\n ]\n}\n}", "name": "given data was invalid" } ] }, { "name": "Getting Amazon dimensions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/amazon-dimensions-data", "query": [], "raw": "{{baseUrl}}\/api\/v1\/amazon-dimensions-data" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns the dimensions of active Amazon products.\nThe response includes the SKU and item dimensions such as weight,\nheight, length, and width. All dimensions are returned in kilograms and meters.\n\nOnly active products are included in the report.\nIf no active products are found, a corresponding error message will be returned.\nThe information is returned in JSON format." }, "response": [ { "header": [], "code": 200, "body": "{\n \"count\": 2,\n \"data\": [\n {\n \"sku\": \"ABC123\",\n \"weight\": 1.25,\n \"height\": 0.12,\n \"length\": 0.34,\n \"width\": 0.18\n },\n {\n \"sku\": \"DEF456\",\n \"weight\": 0.80,\n \"height\": 0.10,\n \"length\": 0.25,\n \"width\": 0.15\n }\n ]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 404, "body": "{\n \"error\": \"No products found\"\n}", "name": "no products found" }, { "header": [], "code": 404, "body": "{\n \"error\": \"No active products found\"\n}", "name": "no active products found" } ] } ] }, { "name": "Shipments management", "description": "", "item": [ { "name": "Sending shipments information", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/shipment-data", "query": [], "raw": "{{baseUrl}}\/api\/v1\/shipment-data" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"orders\":[\"alias\"]}" }, "description": "This method allows you to send shipment information for given orders.\n\nEach order must contain at least one shipment. Currently supported platform: \"allegro\".\n\nPlease note:\n- If the order already has a shipment, it will be skipped.\n- If at least one shipment is saved successfully, response will reflect both saved and skipped orders.\n- If all shipments already exist, response will return only skipped orders.\n- Shipment weight must be provided in kilograms.\n- Shipment height, width, and length must be provided in centimeters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"All shipments saved successfully.\"\n}", "name": "success - all saved" }, { "header": [], "code": 200, "body": "{\n \"message\": \"Some shipments were saved successfully, but some orders were skipped because shipments already exist.\",\n \"skipped_orders\": [\n \"d94aee70-7e52-11f0-afc4-5debbe59dc7d\"\n ]\n}", "name": "success - some skipped" }, { "header": [], "code": 200, "body": "{\n \"message\": \"No shipments were saved. Shipments already exist for all provided orders.\",\n \"skipped_orders\": [\n \"d94aee70-7e52-11f0-afc4-5debbe59dc7d\"\n ]\n}", "name": "no shipments saved" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"orders.0.shipments.0.type\": [\n \"The selected type is invalid. Allowed values: PDF_A4, PDF_A6, ZPL.\"\n ],\n \"orders.0.shipments.0.weight\": [\n \"Shipment weight is required.\"\n ],\n \"orders.0.shipments.0.platform\": [\n \"Platform must be either \\\"allegro\\\".\"\n ]\n }\n}", "name": "invalid data" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" } ] }, { "name": "Getting shipment label", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/shipment-label\/:platform\/:order_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/shipment-label\/:platform\/:order_id", "variable": [ { "id": "platform", "key": "platform", "value": "allegro", "description": "Shipment platform. Only \"allegro\" is supported." }, { "id": "order_id", "key": "order_id", "value": "d94aee70-7e52-11f0-afc4-5debbe59dc7d", "description": "The ID of the order to fetch labels for." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method allows you to retrieve the shipment labels for a given order.\nCurrently, only the \"allegro\" platform is supported.\n\nPlease note:\n- Label filenames correspond to the order ID. If an order has multiple shipment labels, each file will have a suffix \"_1\", \"_2\", etc.\n- Label files can be in PDF or ZPL format.\n- Each shipment will be paired with its corresponding label file(s)." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"carrier\": \"ALLEGRO\",\n \"tracking_number\": \"AD0000K0B6\",\n \"file\": {\n \"filename\": \"d94aee70-7e52-11f0-afc4-5debbe59dc7d_1.pdf\",\n \"content\": \"JVBERi0xLjQKJeLjz9MKM...\"\n }\n },\n {\n \"carrier\": \"ALLEGRO\",\n \"tracking_number\": \"AD0000K0A8\",\n \"file\": {\n \"filename\": \"d94aee70-7e52-11f0-afc4-5debbe59dc7d_2.zpl\",\n \"content\": \"XlhBDQpeQ0kyOA0KXkZP...\"\n }\n }\n]", "name": "success" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Unknown platform: {platform}\"\n}", "name": "platform not supported" }, { "header": [], "code": 404, "body": "{\n \"error\": \"Order not found\"\n}", "name": "order not found" }, { "header": [], "code": 404, "body": "{\n \"error\": \"No shipments found for order\"\n}", "name": "no shipments found" } ] }, { "name": "Confirm orders are ready for pickup", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/:platform\/confirm-orders-ready-for-pickup", "query": [], "raw": "{{baseUrl}}\/api\/v1\/:platform\/confirm-orders-ready-for-pickup", "variable": [ { "id": "platform", "key": "platform", "value": "allegro", "description": "The platform of the order. Allowed values: \"allegro\"." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"orders\":[\"d94aee70-7e52-11f0-afc4-5debbe59dc7d\",\"d94aee70-7e52-11f0-afc4-5debbe59dc7e\"]}" }, "description": "This method allows merchants to confirm that selected orders are ready for courier pickup.\n\nNotes:\n- Only orders with shipments that have a status allowing pickup confirmation can be confirmed.\n- If a shipment is already marked as ready for pickup, it will be listed in `already_confirmed_orders`.\n- Orders that cannot be confirmed (e.g., shipment not yet ready) will be listed in `cannot_confirm_orders`.\n- Orders not found in the system will be listed in `not_found_orders`.\n- Pickup scheduling logic:\n - When this request is received, the system will first try to schedule a courier for the next day between 12:00 and 17:00.\n - If the next day is Friday or Saturday, the system will look for a courier on Monday instead.\n - If no suitable pickup time is available for that day, the system will take the first available proposal on the following working day, with hours between 08:00 and 17:00." }, "response": [ { "header": [], "code": 200, "body": "{\n \"message\": \"Pickup readiness confirmation processed.\",\n \"confirmed_orders\": [\"d94aee70-7e52-11f0-afc4-5debbe59dc7d\"],\n \"already_confirmed_orders\": [\"d94aee70-7e52-11f0-afc4-5debbe59dc7e\"],\n \"cannot_confirm_orders\": [\"d94aee70-7e52-11f0-afc4-5debbe59dc7f\"],\n \"not_found_orders\": [\"d94aee70-7e52-11f0-afc4-5debbe59dc80\"]\n}", "name": "success" }, { "header": [], "code": 422, "body": "{\n \"error\": \"orders array is required\"\n}", "name": "missing or invalid orders array" }, { "header": [], "code": 422, "body": "{\n \"error\": \"Unknown platform: xyz\"\n}", "name": "unknown platform" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" } ] } ] }, { "name": "Statistics management", "description": "", "item": [ { "name": "Getting performances data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/performances", "query": [ { "key": "date", "value": "2025-10-23", "description": "optional Date in format YYYY-MM-DD. Returns data for this date.", "disabled": false }, { "key": "days_back", "value": "3", "description": "optional Number of days back to include, counting from the given date (or today if date is not provided). Minimum is 1.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/performances?date=2025-10-23&days_back=3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns performance information for a specific date and optionally for the past N days. If no parameters\nare provided, the data for today will be returned.\n\nThe behavior depends on the query parameters provided:\n- If no parameters are provided, data for today will be returned.\n- If only `days_back` is provided, data for today and the previous N-1 days will be returned.\n Example: `days_back=3` on 2025-10-23 returns data for 2025-10-21, 2025-10-22, and 2025-10-23.\n- If both `date` and `days_back` are provided, data will start from `date - (days_back-1)` up to `date`.\n Example: `date=2025-10-23&days_back=3` returns data for 2025-10-21, 2025-10-22, and 2025-10-23." }, "response": [ { "header": [], "code": 200, "body": "{\n \"start_date\": \"2025-10-21\",\n \"end_date\": \"2025-10-23\",\n \"data\": \"[{\\\"2025-10-21\\\":{...}}, {\\\"2025-10-22\\\":{...}}, {\\\"2025-10-23\\\":{...}}]\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"unknown_param\": [\"Unknown parameter: abc. Allowed parameters are 'date' and 'days_back'.\"]\n }\n}", "name": "unknown parameter" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"date\": [\"Invalid date format. Expected YYYY-MM-DD.\"]\n }\n}", "name": "invalid date format" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"date\": [\"Invalid date. Day does not exist in this month.\"]\n }\n}", "name": "invalid date value" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"days_back\": [\"The days_back must be a numeric value greater than or equal to 0.\"]\n }\n}", "name": "invalid days_back" } ] } ] }, { "name": "Test data management", "description": "", "item": [ { "name": "Restore test orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/restore-test-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/restore-test-orders" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "When testing orders, the status of the orders is changing.\nThis method restores all test orders to the status \"new\".\nThis method can be accessed only by \"Test\" user." }, "response": [ { "header": [], "code": 200, "body": "{\n []\n}", "name": "orders restored successfully" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Incorrect user.\"\n}", "name": "incorrect user" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" } ] }, { "name": "Restore VAT calculations data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/restore-test-vat-calculations-data", "query": [], "raw": "{{baseUrl}}\/api\/v1\/restore-test-vat-calculations-data" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "When testing VAT calculations data, the status of the VAT calculations data is changing.\nThis method restores all test VAT calculations data to the status \"new\".\nThis method can be accessed only by \"Test\" user." }, "response": [ { "header": [], "code": 200, "body": "{\n []\n}", "name": "VAT calculations data restored successfully" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Incorrect user.\"\n}", "name": "incorrect user" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" } ] }, { "name": "Restore Allegro test orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/allegro-restore-test-orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/allegro-restore-test-orders" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "When testing orders, the status of the orders is changing.\nThis method restores all test orders to the status \"new\".\nThis method can be accessed only by \"Test\" user." }, "response": [ { "header": [], "code": 200, "body": "{\n []\n}", "name": "orders restored successfully" }, { "header": [], "code": 422, "body": "{\n \"message\": \"Incorrect user.\"\n}", "name": "incorrect user" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" } ] } ] }, { "name": "VAT calculations data management", "description": "", "item": [ { "name": "Getting new VAT calculations data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/new-vat-calculations-data", "query": [], "raw": "{{baseUrl}}\/api\/v1\/new-vat-calculations-data" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all new VAT calculations data and \"request_id\". We recommend\nsaving \"request_id\" and sending it back to us using the method\n\"confirm-vat-calculations-data\u201d. It will confirm you received the VAT calculations data, and you\nwill not receive the same VAT calculations data again next time.\n\nThe field \"buyer_company_name\" will be empty for new VAT calculation data.\nThis field will be filed later and information will be available through the method \"Getting VAT calculations data by date\".\n\nIn this link you can check full example of VAT calculation data:\nLink to example<\/a>" }, "response": [ { "header": [], "code": 200, "body": "{\n\"request_id\": 1234,\n\"vat_calculations_data\": [\n{\n \"marketplace_id\": \"AB\",\n \"status\": \"new\",\n \"vat_invoice_number\": \"ABC-DE-FGHI-0123456789-0123-01\",\n \"shipment_date\": \"1234-01-01 00:00:00\",\n \"order_date\": \"1234-01-01 00:00:00\",\n \"transaction_type\": \"NULL\",\n Other VAT invoice information...\n {\n \"shipment_id\": \"0123456789\",\n \"asin\": \"B012345678\",\n \"sku\": \"12345\",\n \"quantity\": \"1\",\n \"our_price_tax_inclusive_selling_price\": \"12,12\",\n \"our_price_tax_amount\": \"12,12\",\n Other VAT invoice detail information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no new VAT calculations data" } ] }, { "name": "Confirmation of receiving new VAT calculations data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/confirm-vat-calculations-data", "query": [], "raw": "{{baseUrl}}\/api\/v1\/confirm-vat-calculations-data" }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"request_id\":\"1234\"}" }, "description": "This method confirms you received the VAT calculations data. You need to send us\nthe \"request_id\", which you received after using the method \"new-vat-calculations-data\".\nIt will confirm you received the data, and you will\nnot receive the same VAT calculations data again next time." }, "response": [ { "header": [], "code": 200, "body": "{\n\"message\": \"Data was received successfully.\"\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"request_id\": [\n \"The request id must be between 1 and 10 digits.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "the selected request id already confirmed or does not exist" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n \"errors\": \"Provided request_id was incorrect\"\n}", "name": "request_id was incorrect" } ] }, { "name": "Getting VAT calculations data by date", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/vat-calculations-data\/:year\/:month\/:day", "query": [], "raw": "{{baseUrl}}\/api\/v1\/vat-calculations-data\/:year\/:month\/:day", "variable": [ { "id": "year", "key": "year", "value": "2022", "description": "Year is required and will return VAT calculations data for the selected year." }, { "id": "month", "key": "month", "value": "1", "description": "Month is required and will return VAT calculations data for the selected month." }, { "id": "day", "key": "day", "value": "7", "description": "optional Day is optional and will return VAT calculations for the selected day of the given month and year." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This method returns all VAT calculations data\nfor the selected year and month.\nIt is not possible to receive information older than 2 years." }, "response": [ { "header": [], "code": 200, "body": "{\n\"vat_calculations_data\": [\n{\n \"marketplace_id\": \"AB\",\n \"status\": \"new\",\n \"vat_invoice_number\": \"ABC-DE-FGHI-0123456789-0123-01\",\n \"shipment_date\": \"1234-01-01 00:00:00\",\n \"order_date\": \"1234-01-01 00:00:00\",\n \"transaction_type\": \"NULL\",\n Other VAT invoice information...\n {\n \"shipment_id\": \"0123456789\",\n \"asin\": \"B012345678\",\n \"sku\": \"12345\",\n \"quantity\": \"1\",\n \"our_price_tax_inclusive_selling_price\": \"12,12\",\n \"our_price_tax_amount\": \"12,12\",\n Other VAT invoice detail information...\n }\n}\n]\n}", "name": "success" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "wrong token" }, { "header": [], "code": 200, "body": "{\n []\n}", "name": "there are no VAT calculations data for this date" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"year\": [\n \"The year must be 4 digits.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n \"errors\": \"Records older than two years cannot be retrieved\"\n}", "name": "older than two years" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"month\": [\n \"The month must be number greater than 0 and less than 13.\"\n ]\n}\n}", "name": "given data was invalid" }, { "header": [], "code": 422, "body": "{\n\"message\": \"The given data was invalid.\",\n\"errors\": {\n \"day\": [\n \"The day must be between 1 and 31.\"\n ]\n}\n}", "name": "invalid day" } ] } ] } ], "auth": { "type": "bearer" } }