API used for communication with Idealog WMS.
\nConnection to the API is made using Basic authentication.
\nTo communicate with the system, the integration module must be activated. This can be activated by an user with Admin role.
\nThe endpoint allow following operations:
\nImport - import of data into WMS
\nExport - data retrieval of data from WMS
\nData for import is sent in JSON format in request body.
\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors found, an application admin will be adviced.
\nMany of data fields are optional. The mandatory ones are marked with [M] at the end of field description (Code (string): The code of the product [M])
\nThe response data will be returned paged. The page number cand be specified in request. The response will be in JSON format with following structure:
\ntotalItems (int): total number of records after applying filters.
itemsCount (int): the number of records returned in current response.
page (int): current page number
data (json array): data payload.
Idealog WebPlatform API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an internal error.
\nIn case of error, error text or details are send as plain text in response.
\n","event":[{"listen":"prerequest","script":{"id":"eda11c7b-2388-4724-970d-17073ac9b1bf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"188744f9-ab7d-4016-b9fc-598d97d4b829","type":"text/javascript","exec":[""]}}],"_postman_id":"d8555661-4d02-4d03-bffc-ac7c33ae150d","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"d979cc20-0804-44d8-bf76-4622a62976e4","id":"d979cc20-0804-44d8-bf76-4622a62976e4","name":"Idealog API - WMS","type":"collection"}}},{"name":"Partners","item":[{"name":"Import partners","event":[{"listen":"test","script":{"id":"a3686005-3568-4222-87ac-24f9c95d5319","exec":["\r","pm.test(\"Response status code is 202\", function () {\r"," pm.expect(pm.response.code).to.equal(202);\r","});\r","\r","\r","pm.test(\"Response Content-Type header is text/xml\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"text/xml\");\r","});\r","\r","\r","pm.test(\"Response body is null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Verify that the response body is empty or null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Response time is within acceptable range\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"5f9c1ce6-1d6f-4275-ad9b-543e99483fbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"ExternalID\": \"206198\",\r\n \"Code\": \"206198\",\r\n \"Name\": \"Petpack sacks MIAU-MIAU PUI 10 KG\",\r\n \"IsBeneficiary\": true,\r\n \"IsSupplier\": true,\r\n \"IsTransporter\": true,\r\n \"IsCompany\": true,\r\n \"Importance\": \"1\",\r\n \"FiscalCode\": \"19384\",\r\n \"RegistrationCode\": \"837\",\r\n \"BankAccount\": \"8747392\",\r\n \"BankName\": \"BANK\",\r\n \"Country\": \"Romania\",\r\n \"CountryCode\": \"RO\",\r\n \"County\": \"Ilfov\",\r\n \"City\": \"Bucharest\",\r\n \"Street\": \"Calea Calarasi 161\",\r\n \"StreetNumber\": \"\",\r\n \"PostalCode\": \"20183\",\r\n \"ContactPerson\": \"Ana Popescu\",\r\n \"Email\": \"anap@gmail.com\",\r\n \"PhoneNumber\": \"0736268701\",\r\n \"Latitude\": \"57\",\r\n \"Longitude\": \"93\",\r\n \"GLNCode\": \"123456789\",\r\n \"PartnerActive\": \"1\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://[app_url]/api/wms/partners?sync=true","description":"This endpoint allows you to create new or update partners in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/partners with the necessary partners details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/partners/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors found, an application admin will be adviced.
\n
If is required to process data immediately, query parametersync=truemust be sent. If it is required to process data immediately, query parameter sync=true must be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request body should be in json format and should include the following parameters ([M] - mandatory):
\nCode (string): The code of the product [M]
\nName (string): The name of the product [M - for new items]
\nExternalID (string): The external ID of the partner. The uniwue ID of the partner from the system that send data.
\nIsBeneficiary (bool): True if the partner is a beneficiary
\nIsSupplier (bool): True if the partner is a supplier
\nIsTransporter (bool): True if the partner is a transporter
\nIsCompany (bool): True if the partner is a company, else if it is a phical person
\nImportance (int): A number that represent the importance of the partner. Lower number represent most important partners.
\nFiscalCode (string): The fiscal code of the partner
\nRegistrationCode (string): The legal registration code of the partner
\nBankAccount (string): Partner's bank account
\nBankName (string): The name of the bank where the bank account exists
\nCountry (string): The country where the partner resides
\nCountryCode (string): The country code where the partner resides
\nCounty (string): The county where the partner resides
\nCity (string): The city where the partner resides
\nStreet (string): The street where the partner resides
\nStreetNumber (string): The street number where the partner resides
\nPostalCode (string): The postal code where the partner resides
\nContactPerson (string): The contact person of the partner
\nEmail (string): The email address of the partner
\nPhoneNumber (string): The phone number of the partner
\nLatitude (decimal):
\nLongitude (decimal):
\nGLNCode (string): The Global Location Number Code
\nPartnerActive (bool):
\nSalesPerson (string):
\nUpon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"41291\",\n \"InternalID\": 32953\n }\n]\n\nThis endpoint allows you to create new or update partner addresses in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/partnersAddresses with the necessary address details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/partnersAddresses/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors found, an application admin will be adviced.
\n
If is required to process data immediately, query parametersync=truemust be sent. If it is required to process data immediately, query parameter sync=true must be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request body should be in json format and should include the following parameters ([M] - mandatory):
\nCode (string): The code of the product [M]
\nName (string): The name of the product [M - for new items]
\nExternalID (string): The external ID of the product. The ID of the product from the system that send data.
\nIsBeneficiary (bool): Returns true if the partner is a beneficiary, else false (?)
\nIsSupplier (bool): Returns true if the partner is a supplier, else false (?)
\nIsTransporter (bool): Returns true if the partner is a transporter, else false (?)
\nIsCompany (bool): Returns true if the partner is a company, else false (?)
\nImportance (int): (?)
\nFiscalCode (string): The fiscal code of the partner
\nRegistrationCode (string): The legal registration code of the partner
\nBankAccount (string): Partner's bank account
\nBankName (string): The name of the bank where the bank account exists
\nCountry (string): The country where the partner resides
\nCountryCode (string): The country code where the partner resides
\nCounty (string): The county where the partner resides
\nCity (string): The city where the partner resides
\nStreet (string): The street where the partner resides
\nStreetNumber (string): The street number where the partner resides
\nPostalCode (string):The postal code where the partner resides
\nContactPerson (string): The contact person of the partner
\nEmail (string): The official email of the partner
\nPhoneNumber (string): The phone number of the partner
\nLatitude (decimal): (?)
\nLongitude (decimal): (?)
\nGLNCode (string): The Global Location Number Code
\nPartnerExternalID (string): The external ID of the partner. The partner ID from source system. [M]
\nPartnerName (string): The partner's name
\nUpon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"41291\",\n \"InternalID\": 32953\n }\n]\n\nThis endpoint allows you to create new or update products in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/products with the necessary product details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/products/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors are found, an application admin will be adviced.
\n
If it is required to process data immediately, query parametersync=truemust be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request body should be in json format and should include the following parameters ([M] - mandatory):
\nExternalID (string): The external ID of the product. The product unique ID from source system. [M]
\nCode (string(200)): The code of the product [M]
\nName (string(200)): The name of the product [M - for new items]
\nProductTypeCode (string): Product type. Can have values:
\nBASE - Base product
\nCMN - Common product (this is usually used)
\nSRV - Service, not storable product.
\nPKG - Package
\nKIT - Assembly of products
\nVKT - Virtual kit. A product that does not exist physically but is composed of products that exist physically.
\nMeasuringUnit (string): The name of the measuring unit for the product [M - for new items]. The measuring unit must be present in app. If not, the product will not be created. Can send measuring unit code or name.
\nCategory (string): The category of the product
\nGroup (string): The group of the product
\nWeight (double): Product weight (in kg)
\nDepth (double): Product depth (in cm)
\nWidth (double): Product width (in cm)
\nHeight (double): Product height (in cm)
\nVolume (double): Product volume (in m3)
\nBarcode (string): product barcode
\nBarcode2 (string): product aditional barcode
\nBatchCriteria (string): a code that define the criteria of product \"batching\". This code must be provided by host. If a product is not tracker by batch, this field can be ignored.
\nLifeTime (int): Indicates the number of days of product expiration
\nHasSN (bool): Indicates if the product has a serial number
\nSerialNumberProfileCode (string): The profile code that defines the serial number settings according to the configurations in the application
\nPrice (decimal): The price of the product.
\nImageURL (string): The URL of the product image. If a product has multiple images, they must be separated by [~~]
\nUpon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"1723793453\",\n \"InternalID\": 32953\n }\n]\n\nThis endpoint allows you to create new or update products in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/products with the necessary product details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/products/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors are found, an application admin will be adviced.
\n
If it is required to process data immediately, query parametersync=truemust be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request body should be in json format and should include the following parameters ([M] - mandatory):
\nExternalID (string): The external ID of the product. The product unique ID from source system. [M]
\nCode (string(200)): The code of the product [M]
\nName (string(200)): The name of the product [M - for new items]
\nProductTypeCode (string): Product type. Can have values:
\nBASE - Base product
\nCMN - Common product (this is usually used)
\nSRV - Service, not storable product.
\nPKG - Package
\nKIT - Assembly of products
\nVKT - Virtual kit. Assembly of products that not exists phisically
\nMeasuringUnit (string): The name of the measuring unit for the product [M - for new items]. The measuring unit must be present in app. If not, the product will not be created. Can send measuring unit code or name.
\nCategory (string): The category of the product
\nGroup (string): The group of the product
\nWeight (double): Product weight (in kg)
\nDepth (double): Product depth (in cm)
\nWidth (double): Product width (in cm)
\nHeight (double): Product height (in cm)
\nVolume (double): Product volume (in m3)
\nBarcode (string): product barcode
\nBarcode2 (string): product aditional barcode
\nBatchCriteria (string): a code that define the criteria of product \"batching\". This code must be provided by host. If a product is not tracker by batch, this field can be ignored.
\nLifeTime (int): Indicates the number of days of product expiration
\nHasSN (bool): Indicates if the product has a serial number
\nPrice (decimal): The price of the product.
\nImageURL (string): The URL of the product image. If a product has multiple images, they must be separated by [~~]
\nUpon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"1723793453\",\n \"InternalID\": 32953\n }\n]\n\nThis endpoint allows you to create inbound orders in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/inbounds with the necessary order details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/inbounds/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors found, an application admin will be adviced.
\n
If is required to process data immediately, query parametersync=truemust be sent. If it is required to process data immediately, query parameter sync=true must be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request body should be in JSON format and include the following parameters ([M] - mandatory):
\nExternalID (string): The external ID of the order. The order ID from source system. [M]
OrderTypeCode (string): order type. The value must exists in WMS application.
OrderBatch (string): The order batch.
OrderNumber (string): The order number. [M]
Warehouse (string): The warehouse code where the order will be received. [M]
ReceptionDate (DateTime): The date of receiving the order.
OrderDate (DateTime): The date of the order.
SupplierExternalID (string): The external ID of the supplier. [M, O - if SupplierCode is specified]
SupplierCode (string): The code of the supplier. [M, O - if SupplierExternalID is specified]
OrderPriority (int): The order priority. Minimum value is 10. Default value 100.
SupplierName (string): The name of the supplier.
SupplierOrderNumber (string): The order number from the supplier.
isReturn (boolean): Indicates if the order is a return. Default value is false.
BlockReason (string): if is filled the order will be automatically blocked with this reason
Comments1 (string): Additional comments field 1.
Comments2 (string): Additional comments field 2.
OrderLines (array): [M] An array of order line objects with the following parameters:
ExternalLineID (string): The line ID from source system.
LineNumber (string): The line number of the order.
ExternalItemID (string): The external ID of the item.
ItemCode (string): The code of the item. [M]
ItemName (string): The name of the item.
QuantityOrdered (double): The quantity of the item ordered [M]
Price (decimal): The item price (per unit of measure)
Upon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"1723793479\",\n \"InternalID\": 32953\n }\n]\n\nsync (bool): [O] if true is sent, the request will be processed immediatelly, otherwise will be inserted in the buffer for future process.This endpoint allows you to cancel an Inbound order in the WMS. The HTTP DELETE request should be sent to [app URL]/api/wms/inbounds.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/inbounds/[partner owner code]
\nThe endpoint accepts 2 method of filtering:
\nBy ExternalID - ExternalID is the ID of the order from external system. ExternalID can be passed in URL ([app URL]/api/wms/export/inbounds/ExternalID) or as query parameter ([app URL]/api/wms/export/inbounds?externalID=value)
By ID - ID is the internal ID of WMS. The ID can be passed only as query parameter ([app URL]/api/wms/export/inbounds?id=value)
Upon successful execution, the endpoint returns a status code of 200 (Ok) with a exmpty body response.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"d979cc20-0804-44d8-bf76-4622a62976e4","id":"d979cc20-0804-44d8-bf76-4622a62976e4","name":"Idealog API - WMS","type":"collection"}},"urlObject":{"path":["wms","inbounds","1467067"],"host":["https://[app_url]/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"ed43a94a-1444-438d-8212-38b82026f849"},{"name":"Cancel order - by Internal WMS ID","event":[{"listen":"test","script":{"id":"a3686005-3568-4222-87ac-24f9c95d5319","exec":["\r","pm.test(\"Response status code is 202\", function () {\r"," pm.expect(pm.response.code).to.equal(202);\r","});\r","\r","\r","pm.test(\"Response Content-Type header is text/xml\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"text/xml\");\r","});\r","\r","\r","pm.test(\"Response body is null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Verify that the response body is empty or null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Response time is within acceptable range\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"b650aacd-660d-4ec9-9a3f-f41c1de0f1c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"ExternalID\": \"1775693033\",\r\n \"OrderBatch\": \"SO\",\r\n \"OrderNumber\": \"123456\",\r\n \"Warehouse\": \"DC\",\r\n \"OrderDate\": \"2024-01-04\",\r\n \"BeneficiaryExternalID\": \"\",\r\n \"BeneficiaryCode\": \"BENEF1\",\r\n \"BeneficiaryName\": \"\",\r\n \"BeneficiaryOrderNumber\": \"Numar comanda beneficiar\",\r\n \"isReturn\": \"0\",\r\n \"Comments1\": \"comments 1\",\r\n \"Comments2\": \"comments 2\",\r\n \"ShippingDetails\": {\r\n \"DeliveryDate\": \"2024-01-20\",\r\n \"ShippingDate\": \"2024-01-20\",\r\n \"ShippingMethod\": \"Courier\",\r\n \"Courier\": \"Fan\",\r\n \"TransporterCode\": \"\",\r\n \"CourierIntegratorCode\": \"\",\r\n \"ShippingService\": \"\",\r\n \"COD\": \"true\",\r\n \"CODValue\": \"126.55\",\r\n \"CODType\": \"CASH\",\r\n \"AWBCode\": \"\",\r\n \"AWBURL\": \"\",\r\n \"LockerCode\": \"\",\r\n \"ShippingDetails\": \"Interfon 01\",\r\n \"DeliveryRoute\": \"cod ruta livrare\"\r\n },\r\n \"BillingAddress\": {\r\n \"Country\": \"RO\",\r\n \"County\": \"B\",\r\n \"City\": \"Sector 3\",\r\n \"Street\": \"Calea Calarasi\",\r\n \"StreetNumber\": \"161\",\r\n \"PostalCode\": \"032716\",\r\n \"ContactPerson\": \"Persoana Contact\",\r\n \"Email\": \"email@idealog.ro\",\r\n \"PhoneNumber\": \"0745265242\",\r\n \"Latitude\": \"44.43279\",\r\n \"Longitude\": \"26.12345\"\r\n },\r\n \"ShippingAddress\": {\r\n \"Country\": \"RO\",\r\n \"County\": \"B\",\r\n \"City\": \"Sector 3\",\r\n \"Street\": \"Calea Calarasi\",\r\n \"StreetNumber\": \"161\",\r\n \"PostalCode\": \"032716\",\r\n \"ContactPerson\": \"Persoana Contact\",\r\n \"Email\": \"email@idealog.ro\",\r\n \"PhoneNumber\": \"0745265242\",\r\n \"Latitude\": \"44.43279\",\r\n \"Longitude\": \"26.12345\"\r\n },\r\n \"OrderLines\": [\r\n {\r\n \"ExternalLineID\": \"1775693033\",\r\n \"LineNumber\": \"001\",\r\n \"ExternalItemID\": \"ABC121\",\r\n \"ItemCode\": \"FMA9\",\r\n \"ItemName\": \"Folie magnetică cu adeziv (1m) - 0,9mm\",\r\n \"QuantityOrdered\": \"23\"\r\n },\r\n {\r\n \"ExternalLineID\": \"1775693033\",\r\n \"LineNumber\": \"002\",\r\n \"ExternalItemID\": \"ABC121\",\r\n \"ItemCode\": \"FMA9\",\r\n \"ItemName\": \"Folie magnetică cu adeziv (1m) - 0,9mm\",\r\n \"QuantityOrdered\": \"57\",\r\n \"Price\": 120,\r\n \"VATValue\": 20\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://[app_url]/api/wms/inbounds?id=32959","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"d979cc20-0804-44d8-bf76-4622a62976e4","id":"d979cc20-0804-44d8-bf76-4622a62976e4","name":"Idealog API - WMS","type":"collection"}},"urlObject":{"path":["wms","inbounds"],"host":["https://[app_url]/api"],"query":[{"key":"id","value":"32959"}],"variable":[]}},"response":[],"_postman_id":"b650aacd-660d-4ec9-9a3f-f41c1de0f1c1"},{"name":"Export - by External ID","event":[{"listen":"test","script":{"id":"a3686005-3568-4222-87ac-24f9c95d5319","exec":["\r","pm.test(\"Response status code is 202\", function () {\r"," pm.expect(pm.response.code).to.equal(202);\r","});\r","\r","\r","pm.test(\"Response Content-Type header is text/xml\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"text/xml\");\r","});\r","\r","\r","pm.test(\"Response body is null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Verify that the response body is empty or null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Response time is within acceptable range\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"17a8ffda-a014-4222-85ca-4ad8d831b110","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://[app_url]/api/wms/export/inbounds/Test1245","description":"This endpoint allows you to retrieve informations about inbound orders from WMS. The HTTP POST request should be sent to [app URL]/api/wms/export/inbounds with filtering parameters.
The endpoint will return records in pages with a maximum 50 records. The page number can be specified.
\nThe endpoint accepts 3 method of filtering:
\nBy ExternalID - ExternalID is the ID of the order from external system. ExternalID can be passed in URL ([app URL]/api/wms/export/inbounds/ExternalID) or as query parameter ([app URL]/api/wms/export/inbounds?externalID=value)
By ID - ID is the internal ID of WMS. The ID can be passed only as query parameter ([app URL]/api/wms/export/inbounds?id=value)
Other filters - are passed in request body in JSON format. Accepted filters:
\nstartDate - date when the order was created in WMS
endDate - date when the order was created in WMS
finished - true/false - filter finished or active orders. If is not specified will return both finished and active orders.
isReturn - true/false - filter returns vs normal orders. If is not specified will return both returns and normal orders.
page - page number
ExternalIDs - array of strings - external IDs of orders from external system.
If this filter is used, pagination will be disabled and all records will be returned.
InternalIDs - array of int - IDs of orders from WMS
If this filter is used, pagination will be disabled and all records will be returned.
The response body will be in JSON format with following structure:
\ntotalItems (int): total number of records after applying filters.
itemsCount (int): the number of records returned in current response.
page (int): current page number
data (json array): data payload.
Orders data has the folowind properties:
\nExternalID (string): The external ID of the order. The order ID from the source system.
InternalOrderID (int): The order ID from WMS.
OrderBatch (string): The order batch from external system.
OrderNumber (string): The order number from external system.
OrderDate (datetime): The order date.
InternalOrderBatch (string): The order batch from WMS.
InternalOrderNumber (string): The order number from WMS.
Status (string): the order status. An order can have following statuses: ADDED, CONFIRMED, ACTIVATED, FINISHED, CANCELLED
WarehouseCode (string): The warehouse code.
WarehouseName (string): The warehouse Name.
Finished (bool): Specify that the order is finished or not.
FinishedDate (datetime): The date when the order was finished.
SupplierExternalID (string): The ID of the supplier from external system.
SupplierCode (string): The code of the supplier.
SupplierName (string): The name of the supplier.
SupplierOrderNumber (string): The order number from the supplier.
isReturn (bool): Indicates if the order is a return. Default value is false.
Comments1 (string): Additional comments field 1.
AuxValues (json array): The auxiliary order properties if was send from external system on import.
Documents (array): An array with documents registered for this order
Batch (string): document batch
Number (string): document number
Date (date): document date
Type (string): document type
OrderLines (array): An array of order line objects with the following properties:
ExternalLineID (string): The line ID from the source system.
InternalLineID (int): The line ID from WMS.
LineNumber (string): The line number of the order.
ExternalItemID (string): The external ID of the item.
InternalItemID (string): The external ID of the item.
ItemCode (string): The code of the item.
ItemName (string): The name of the item.
QuantityOrdered (decimal): The quantity of the item ordered
QuantityReceived (decimal): The quantity of the item received (?)
QuantityDamaged (decimal): The quantity of the item that is damaged (?)
Price (decimal): The item price (per unit of measure)
AuxValues (json array): The auxiliary lines properties if was send from external system on order import.
StockUnits (array): An array with received pallets
Code (string) : WMS internal pallet code
SSCC (string) : WMS internal pallet SSCC
BatchCode (string)
ExpireDate (date)
Quantity (decimal)
Batches (array): An array with items received batches (if the item is marked with batch)
BatchCode (string)
ExpireDate (date)
Quantity (decimal)
This endpoint allows you to retrieve informations about inbound orders states from WMS. The HTTP POST request should be sent to [app URL]/api/wms/export/inboundsstates with filtering parameters.
The endpoint will return records in pages with a maximum 50 records. The page number can be specified.
\nThe endpoint accepts the same filters like Inbound Orders Info endpoint
\nThe response body will be in JSON format with following structure:
\ntotalItems (int): total number of records after applying filters.
itemsCount (int): the number of records returned in current response.
page (int): current page number
data (json array): data payload.
Orders data has the folowind properties:
\nInternalOrderID (int): The order ID from WMS.
Status (string): the order status. An order can have following the statuses from bellow
Finished (bool): Specify that the order is finished or not.
Cancelled (bool): Specify that the order is cancelled or not.
\nStatusDate (datetime): The date when the order state was changed.
This endpoint allows you to create outbound orders in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/outbounds with the necessary order details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/outbounds/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors found, an application admin will be adviced.
\n
If is required to process data immediately, query parametersync=truemust be sent. If it is required to process data immediately, query parameter sync=true must be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request payload should be in the raw format and should contain a JSON object with the following parameters:
\nExternalID (string): The external ID of the order. [M]
OrderTypeCode (string): order type. The value must exists in WMS application.
OrderBatch (string): The batch number of the order.
OrderNumber (string): The order number. [M]
Warehouse (string): The warehouse where the order is to be processed. Warehouse code is provided by the host.
StockStatusCode (string): The stock status. Stock status code is provided by the host.
OrderDate (date): The registration date of the order.
OrderPriority (int): The order priority. Minimum value is 10. Default value 100.
BeneficiaryExternalID (string): The external ID of the beneficiary (partner).
BeneficiaryCode (string): The code of the beneficiary.
BeneficiaryName (string): The name of the beneficiary.
BeneficiaryOrderNumber (string): The order number of the beneficiary.
(in case of EMag, the order id must be sent in this field)
isReturn (bool): Indicates if the order is a supplier return.
BlockReason (string): if is filled the order will be automatically blocked with this reason
SalesPerson (string): Sales person name or code
Comments1 (string): Additional comments field 1.
Comments2 (string): Additional comments field 2.
ShippingAddress (object): The shipping address details. with same parameters as billing address.
BillingAddress (object): The billing address details with the following parameters:
Country (string): Country code or name. Must be defined in app.
County (string): County code or name. Depending on application settings, must be defined in app.
City (string): City name. Depending on app settings, must be defined in application.
Street (string): The street name. If not exists street number can send entire address in this field.
StreetNumber (string): The number of the street.
PostalCode (string): The postal code of the address. Depending on app settings, can be validated with city.
ContactPerson (string): The name of the contact person
Email (string): The email of the contact person
PhoneNumber (string): The phone number
Latitude (decimal): The latitude of the address
Longitude (decimal): The longitude of the address
ExternalID (string): External ID of the billing address
ShippingDetails (object): The shipping details including country, county, city, street, street number, postal code, contact person, email, phone number, latitude, and longitude.
DeliveryDate (date): The date when the order must be delivered to beneficiary.
ShippingDate (date): The date when the order must be ready for pick-up/deliver from warehouse.
ShippingMethod (string): The shipping method. Must be defined in app.
Courier (string): The courier name or code. Must be defined in app.
TransporterCode (string): The code of the transporter. Must be defined in app.
CourierIntergratorCode (string): The code of the courier integrator (Postis, Innoship, etc.). Must be defined in app.
COD (bool): Cash on delivery. If some money must be collected on delivery. Default value is false.
CODValue (decimal): The amount of money to be collected.
CODCurrency (string): The currency in wich money must be collected.
CODType (string): The type of money collection. Accepted values: CASH, BANK, None, CARD.
CODCurrency (string): The type of currency.
AWBCode (string): The AWB code if this was generated by external system.
AWBURL (string): The URL from where AWB can be downloaded if this was generated by external system.
LockerCode (string): Locker code in case of delivery to a locker.
ShippigDetails (string): Notes for delivery.
DeliveryRoute (string): Delivery route if this was defined in external system.
InsuranceValue (decimal): The value of the insurance. Used for courier delivery.
MorningDelivery (bool): Used for courier delivery.
OpenPackage (bool): Used for courier delivery.
PriorityDelivery (bool): Used for courier delivery.
SaturdayDelivery (bool): Used for courier delivery.
ReturnDocuments (string): Used for courier delivery.
ShippingContactPerson (string):
ShippingContactPhoneNumber (string):
ShippigDetails (string): Notes for delivery.
DelegatedPerson (string):
OrderLines (array): [M] An array of order line objects with the following parameters:
ExternalLineID (string): The line ID from source system.
LineNumber (string): The line number of the order.
ExternalItemID (string): The external ID of the item.
ItemCode (string): The code of the item. [M]
ItemName (string): The name of the item.
QuantityOrdered (string): The quantity of the item ordered. [M]
Price (decimal): The item price (per unit of measure)
VATValue (decimal): The item vat value (per unit of measure)
Details:
\nnormally a beneficiary data must be send using Partners API method. If the beneficiary data are not very important (usually when the orders are sent from online store where beneficiaries are new everytime), the call of Partners API can be skiped and the beneficiary will be created automatically from order data. For this following fields must be send:
\nBeneficiaryName
\nShippingAddress and BillingAddress. If billing address and shipping address are the same everytime, only ShippingAddress can be sent.
\nUpon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"1723793514\",\n \"InternalID\": 32953\n }\n]\n\nThis endpoint allows you to cancel an outbound order in the WMS. The HTTP DELETE request should be sent to [app URL]/api/wms/outbounds.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/outbounds/[partner owner code]
\nThe endpoint accepts 2 method of filtering:
\nBy ExternalID - ExternalID is the ID of the order from external system. ExternalID can be passed in URL ([app URL]/api/wms/export/outbounds/ExternalID) or as query parameter ([app URL]/api/wms/export/outbounds?externalID=value)
By ID - ID is the internal ID of WMS. The ID can be passed only as query parameter ([app URL]/api/wms/export/outbounds?id=value)
Upon successful execution, the endpoint returns a status code of 200 (Ok) with a exmpty body response.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"d979cc20-0804-44d8-bf76-4622a62976e4","id":"d979cc20-0804-44d8-bf76-4622a62976e4","name":"Idealog API - WMS","type":"collection"}},"urlObject":{"path":["wms","outbounds","12345"],"host":["https://[app_url]/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"307774ef-0696-4229-abee-e5d7509b87a4"},{"name":"Cancel order - by Internal WMS ID","event":[{"listen":"test","script":{"id":"a3686005-3568-4222-87ac-24f9c95d5319","exec":["\r","pm.test(\"Response status code is 202\", function () {\r"," pm.expect(pm.response.code).to.equal(202);\r","});\r","\r","\r","pm.test(\"Response Content-Type header is text/xml\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"text/xml\");\r","});\r","\r","\r","pm.test(\"Response body is null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Verify that the response body is empty or null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Response time is within acceptable range\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});\r","\r",""],"type":"text/javascript","packages":{}}}],"id":"80e9fdc9-f2c3-4084-9d12-533d80031ea8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"ExternalID\": \"1775693033\",\r\n \"OrderBatch\": \"SO\",\r\n \"OrderNumber\": \"123456\",\r\n \"Warehouse\": \"DC\",\r\n \"OrderDate\": \"2024-01-04\",\r\n \"BeneficiaryExternalID\": \"\",\r\n \"BeneficiaryCode\": \"BENEF1\",\r\n \"BeneficiaryName\": \"\",\r\n \"BeneficiaryOrderNumber\": \"Numar comanda beneficiar\",\r\n \"isReturn\": \"0\",\r\n \"Comments1\": \"comments 1\",\r\n \"Comments2\": \"comments 2\",\r\n \"ShippingDetails\": {\r\n \"DeliveryDate\": \"2024-01-20\",\r\n \"ShippingDate\": \"2024-01-20\",\r\n \"ShippingMethod\": \"Courier\",\r\n \"Courier\": \"Fan\",\r\n \"TransporterCode\": \"\",\r\n \"CourierIntegratorCode\": \"\",\r\n \"ShippingService\": \"\",\r\n \"COD\": \"true\",\r\n \"CODValue\": \"126.55\",\r\n \"CODType\": \"CASH\",\r\n \"AWBCode\": \"\",\r\n \"AWBURL\": \"\",\r\n \"LockerCode\": \"\",\r\n \"ShippingDetails\": \"Interfon 01\",\r\n \"DeliveryRoute\": \"cod ruta livrare\"\r\n },\r\n \"BillingAddress\": {\r\n \"Country\": \"RO\",\r\n \"County\": \"B\",\r\n \"City\": \"Sector 3\",\r\n \"Street\": \"Calea Calarasi\",\r\n \"StreetNumber\": \"161\",\r\n \"PostalCode\": \"032716\",\r\n \"ContactPerson\": \"Persoana Contact\",\r\n \"Email\": \"email@idealog.ro\",\r\n \"PhoneNumber\": \"0745265242\",\r\n \"Latitude\": \"44.43279\",\r\n \"Longitude\": \"26.12345\"\r\n },\r\n \"ShippingAddress\": {\r\n \"Country\": \"RO\",\r\n \"County\": \"B\",\r\n \"City\": \"Sector 3\",\r\n \"Street\": \"Calea Calarasi\",\r\n \"StreetNumber\": \"161\",\r\n \"PostalCode\": \"032716\",\r\n \"ContactPerson\": \"Persoana Contact\",\r\n \"Email\": \"email@idealog.ro\",\r\n \"PhoneNumber\": \"0745265242\",\r\n \"Latitude\": \"44.43279\",\r\n \"Longitude\": \"26.12345\"\r\n },\r\n \"OrderLines\": [\r\n {\r\n \"ExternalLineID\": \"1775693033\",\r\n \"LineNumber\": \"001\",\r\n \"ExternalItemID\": \"ABC121\",\r\n \"ItemCode\": \"FMA9\",\r\n \"ItemName\": \"Folie magnetică cu adeziv (1m) - 0,9mm\",\r\n \"QuantityOrdered\": \"23\"\r\n },\r\n {\r\n \"ExternalLineID\": \"1775693033\",\r\n \"LineNumber\": \"002\",\r\n \"ExternalItemID\": \"ABC121\",\r\n \"ItemCode\": \"FMA9\",\r\n \"ItemName\": \"Folie magnetică cu adeziv (1m) - 0,9mm\",\r\n \"QuantityOrdered\": \"57\",\r\n \"Price\": 120,\r\n \"VATValue\": 20\r\n }\r\n ]\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://[app_url]/api/wms/outbounds?id=1040","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"d979cc20-0804-44d8-bf76-4622a62976e4","id":"d979cc20-0804-44d8-bf76-4622a62976e4","name":"Idealog API - WMS","type":"collection"}},"urlObject":{"path":["wms","outbounds"],"host":["https://[app_url]/api"],"query":[{"key":"id","value":"1040"}],"variable":[]}},"response":[],"_postman_id":"80e9fdc9-f2c3-4084-9d12-533d80031ea8"},{"name":"Export - by External ID","event":[{"listen":"test","script":{"id":"a3686005-3568-4222-87ac-24f9c95d5319","exec":["\r","pm.test(\"Response status code is 202\", function () {\r"," pm.expect(pm.response.code).to.equal(202);\r","});\r","\r","\r","pm.test(\"Response Content-Type header is text/xml\", function () {\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"text/xml\");\r","});\r","\r","\r","pm.test(\"Response body is null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Verify that the response body is empty or null\", function () {\r"," const responseData = xml2Json(pm.response.text());\r"," \r"," pm.expect(responseData).to.be.null;\r","});\r","\r","\r","pm.test(\"Response time is within acceptable range\", function () {\r"," pm.expect(pm.response.responseTime).to.be.below(300);\r","});\r","\r",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b4953353-3e88-47f3-9f3f-8b81fa54f305","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://[app_url]/api/wms/export/outbounds/14492255","description":"This endpoint allows you to retrieve informations about inbound orders from WMS. The HTTP POST request should be sent to [app URL]/api/wms/export/outbounds with filtering parameters.
The endpoint will return records in pages with a maximum 50 records. The page number can be specified.
\nThe endpoint accepts 3 method of filtering:
\nBy ExternalID - ExternalID is the ID of the order from external system. ExternalID can be passed in URL ([app URL]/api/wms/export/outbounds/ExternalID) or as query parameter ([app URL]/api/wms/export/outbounds?externalID=value)
By ID - ID is the internal ID of WMS. The ID can be passed only as query parameter ([app URL]/api/wms/export/outbounds?id=value)
Other filters - are passed in request body in JSON format. Accepted filters:
\nstartDate - date when the order was created in WMS
endDate - date when the order was created in WMS
finished - true/false - filter finished or active orders. If is not specified will return both finished and active orders.
page - page number
ExternalIDs - array of strings - external IDs of orders from external system
If this filter is used, pagination will be disabled and all records will be returned.
InternalIDs - array of int - IDs of orders from WMS
If this filter is used, pagination will be disabled and all records will be returned.
CustomerEmail - string - Customer email address.
StatusCode - string - Order status code. Available status codes: Added, Confirmed, Activated, Finished, Cancelled.
The response body will be in JSON format with following structure:
\ntotalItems (int): total number of records after applying filters.
itemsCount (int): the number of records returned in current response.
page (int): current page number
data (json array): data payload.
Orders data has the folowind properties:
\nExternalID (string): The external ID of the order. The order ID from the source system.
InternalOrderID (int): The order ID from WMS.
OrderBatch (string): The order batch from external system.
OrderNumber (string): The order number from external system.
OrderDate (datetime): The order date.
InternalOrderBatch (string): The order batch from WMS.
InternalOrderNumber (string): The order number from WMS.
Status (string): the order status. An order can have following statuses: ADDED, CONFIRMED, ACTIVATED, FINISHED, CANCELLED
WarehouseCode (string): The warehouse code.
WarehouseName (string): The warehouse Name.
Finished (bool): Specify that the order is finished or not.
FinishedDate (datetime): The date when the order was finished.
BeneficiaryExternalID (string): The ID of the beneficiary from external system.
BeneficiaryCode (string): The code of the beneficiary.
BaneficiaryName (string): The name of the beneficiary.
BeneficiaryOrderNumber (string): The order number from the beneficiary.
isReturn (bool): Indicates if the order is a return. Default value is false.
Comments1 (string): Additional comments field 1.
AuxValues (json array): The auxiliary order properties if was send from external system on import.
Documents (array): An array with documents registered for this order
Batch (string): document batch
Number (string): document number
Date (date): document date
Type (string): document type
OrderLines (array): An array of order line objects with the following properties:
ExternalLineID (string): The line ID from the source system.
InternalLineID (int): The line ID from WMS.
LineNumber (string): The line number of the order.
ExternalItemID (string): The external ID of the item.
InternalItemID (string): The external ID of the item.
ItemCode (string): The code of the item.
ItemName (string): The name of the item.
QuantityOrdered (decimal): The quantity of the item ordered
QuantityDelivered (decimal): The quantity of the item delivered(?)
Price (decimal): The item price (per unit of measure)
AuxValues (json array): The auxiliary lines properties if was send from external system on order import.
StockUnits (array): An array with received pallets
Code (string) : WMS internal pallet code
SSCC (string) : WMS internal pallet SSCC
BatchCode (string)
ExpireDate (date)
Quantity (decimal)
Batches (array): An array with received batches (if the item is marked with batch)
BatchCode (string)
ExpireDate (date)
Quantity (decimal)
SerialNumbers (array): An array with received serial numbers (if the item is marked with serial number)
SerialNumber (string)
SerialNumber2 (string)
IMEI1 (string)
IMEI2 (string)
This endpoint allows you to retrieve informations about outbound orders states from WMS. The HTTP POST request should be sent to [app URL]/api/wms/export/outboundsstates with filtering parameters.
The endpoint will return records in pages with a maximum 50 records. The page number can be specified.
\nThe endpoint accepts the same filters like Outbound Orders Info endpoint
\nThe response body will be in JSON format with following structure:
\ntotalItems (int): total number of records after applying filters.
itemsCount (int): the number of records returned in current response.
page (int): current page number
data (json array): data payload.
Orders data has the folowind properties:
\nInternalOrderID (int): The order ID from WMS.
Status (string): the order status. An order can have following the statuses from bellow
Finished (bool): Specify that the order is finished or not.
Cancelled (bool): Specify that the order is cancelled or not.
\nStatusDate (datetime): The date when the order state was changed.
This endpoint allows you to create new or update persons in the WMS. The HTTP POST request should be sent to [app URL]/api/wms/persons with the necessary persons details in the request body.
\nIf API user have rigths to multiple partners owner, the request should be sent to [app URL]/api/wms/persons/[partner owner code]
\n\n\nRecords are not immediatelly created. The information are stored in a buffer and processed after. On processing, if some errors found, an application admin will be adviced.
\n
If is required to process data immediately, query parametersync=truemust be sent. If it is required to process data immediately, query parameter sync=true must be sent. In this case:
- if an error result on import, data will not be saved in the buffer
- a limit of 1000 recors is set
The request body should be in json format and should include the following parameters ([M] - mandatory):
\nCode (string): The code of the person [M]
\nFirstName (string): The first name of the person [M]
\nLastName (string): The last name of the person [M]
\nEmail (string): The email address of the person.
\nPhoneNumber (string): The phone number address of the person.
\nJobTitle (string): The job title of the person.
\nUsername (string): The username of the person.
\nUpon successful execution, the endpoint returns a status code of 202 (Accepted) with a null response.
\nIf sync=true query parameter is sent, in case of success the endpoint returns a status code of 200 (Ok) with a response that contains ExternalID and InternalID information:
[\n {\n \"ExternalID\": \"41291\",\n \"InternalID\": 32953\n }\n]\n\n