Integration Overview
...
Orders
OR23 - Update Carrier Tracking Information
{ "tab" "examples", "url" "https //saksus2 dev mirakl net/api/orders/{order id}/tracking", "name" "or23 update carrier tracking information", "method" "put", "request" { "pathparameters" \[ { "kind" "required", "name" "order id", "type" "string", "children" \[], "description" "order identifier" } ], "queryparameters" \[ { "kind" "optional", "name" "shop id", "type" "integer", "children" \[], "description" "use this parameter when your user has access to several shops if not specified, the shop id from your default shop will be used " } ], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "" } ], "bodydataparameters" \[ { "kind" "optional", "name" "carrier code", "type" "string", "children" \[], "description" "the code of a carrier this information is mandatory for a registered carrier " }, { "kind" "optional", "name" "carrier name", "type" "string", "children" \[], "description" "the name of a carrier this information is mandatory for an unregistered carrier " }, { "kind" "optional", "name" "carrier url", "type" "string", "children" \[], "description" "the tracking url of a carrier this information is unused for registered carriers (because computed automatically) this information is optional for unregistered carriers " }, { "kind" "optional", "name" "tracking number", "type" "string", "children" \[], "description" "the carrier tracking number this information is mandatory for a registered carrier with a url requiring a tracking number " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "v7dtfm7x5fbgjc quhw8w", "code" "", "language" "204", "customlabel" "" } ], "selectedlanguageid" "v7dtfm7x5fbgjc quhw8w" }, "examples" { "languages" \[ { "id" "k2adkbgccyrso1irm4fs ", "code" "curl location g request put 'https //saksus2 dev mirakl net/api/orders/{order id}/tracking?shop id=integer' \\\\\n header 'accept application/json' \\\\\n header 'authorization string' \\\\\n data raw '{\\"order lines\\" \\"array\\"}'", "language" "curl", "customlabel" "" }, { "id" "sbnypg2o9ligbzvg96kpd", "code" "var request = require('request');\nvar options = {\n 'method' 'put',\n 'url' 'https //saksus2 dev mirakl net/api/orders/{order id}/tracking?shop id=integer',\n 'headers' {\n 'accept' 'application/json',\n 'authorization' 'string'\n },\n body '{\\"order lines\\" \\"array\\"}'\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "h9kadefkppxor4i v1qmh", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"authorization\\", \\"string\\");\n\nvar raw = \\"{\\\\\\"order lines\\\\\\" \\\\\\"array\\\\\\"}\\";\n\nvar requestoptions = {\n method 'put',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //saksus2 dev mirakl net/api/orders/{order id}/tracking?shop id=integer\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "izkxeaerqcj2mek3sctmc", "code" "import requests\n\nurl = \\"https //saksus2 dev mirakl net/api/orders/{order id}/tracking?shop id=integer\\"\n\npayload = \\"{\\\\\\"order lines\\\\\\" \\\\\\"array\\\\\\"}\\"\nheaders = {\n 'accept' 'application/json',\n 'authorization' 'string'\n}\n\nresponse = requests request(\\"put\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "language" "python", "customlabel" "" }, { "id" "yfftok6ce2r 34k te6mj", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //saksus2 dev mirakl net/api/orders/{order id}/tracking?shop id=integer\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http put new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"authorization\\"] = \\"string\\"\nrequest body = \\"{\\\\\\"order lines\\\\\\" \\\\\\"array\\\\\\"}\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" } ], "selectedlanguageid" "k2adkbgccyrso1irm4fs " }, "description" "add shipping carrier & tracking information to an order", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } call frequencies recommended at each order tracking information update (as soon as the seller gets the tracking number from the carrier) maximum at each order tracking information update (as soon as the seller gets the tracking number from the carrier)