General Rules
Standard Directories on CP Servers
list of directories SFTP folders:
| Mode | Message Type | Path |
|---|---|---|
| Transport | ||
| Client Transport Order | /in/transport/clientTransportOrders | |
| Upload Documents | /in/transport/documents | |
| Receive Documents | /out/transport/documents | |
| EventUpdates in | /in/transport/eventUpdates | |
| EventUpdates out | /out/transport/eventUpdates | |
| Invoices Out | /out/invoicing/invoice | |
| Customs In | /in/customs | |
| Logistics | ||
| Dispatch Confirmation | /out/logistics/dispatchConfirmations | |
| Dispatch Order | /in/logistics/dispatchOrders | |
| Dispatch Order Cancelation | /in/logistics/canceldispatchOrders | |
| Logistics Documents | /in/logistics/documents | |
| Inventory Reports | /out/logistics/inventoryReports | |
| Receipt Aviso | /in/logistics/receiptAvisos | |
| Receipt Aviso Update | /in/logistics/receiptAvisosUpdate | |
| Receipt Confirmation | /out/logistics/receiptConfirmations | |
| Receipt Order | /in/logistics/receiptOrders | |
| Item Master | /in/logistics/items | |
| Item Master Update | /in/logistics/itemsUpdate | |
| Customs | ||
| Reimport | /in/customs/reimport | |
| Export | /in/customs/export | |
| Import | /in/customs/import |
Standard Endpoints
example standard Endpoints
www.edi.spotworx.com/dw/Request/{messageType} (opens in a new tab)
Authentification method: basic AUTH
File-based transfer
File name restrictions
The following characters are not allowed in the name of files:
- '< (less than)
- '>' (greater than)
- : (colon)
- " (double quote)
- / (forward slash)
- \ (backslash)
- | (vertical bar or pipe)
- ? (question mark)
- '*' (asterisk)
Best Practice
We recommend PUSH-PUSH communication setup.
Data shall be deleted once pulled from our folders.
MessageHeader
For easier understanding and implementation there is a default message header in each file. We provide this header in XML/JSON to provide information about the file transfer itself.
"...": {
"messageId": "244016",
"messageDate": "2017-04-05",
"messageTime": "13:08:59",
"messageType": "transport.eventUpdate",
"messageVersion": "1.0",
"messageScope": "PROD"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| messageId | String | M | Identifier for tracing in case of error/debugging. |
| messageDate | String | M | Date of message transfer in format YYYY-MM-DD as defined by ISO 8601. |
| messageTime | String | M | UTC Time of message transfer in format hh:mm:ss as defined by ISO 8601. |
| messageType | String | M | Unique identifier to distinguish between different message types. |
| messageVersion | String | M | Message version. |
| messageScope | String | M | Valid values: TEST, PROD |