TB.One > Order Data and Order Processing > Order Processing via XML > Sending and Retrieving Messages via REST
The REST interface is accessed via an URI which includes identification and specifies the desired actions:
https://rest.core.tradebyte.com/ACCOUNTNR/TARGET/[TARGET_ID][/ACTION]?[CHANNEL=CHID] |
|---|
SENDING MESSAGES
Dispatch advices, cancellation or return messages are sent from your system to TB.One.
Method |
POST |
Creates |
|---|---|---|
Target/Resource |
messages |
messages |
Parameter |
File name |
based on the uploaded XML file (content of the message) |
Example |
https://rest.core.tradebyte.com/ACCOUNTNR/messages/? |
|
XML file to be provided: <?xml version="1.0" encoding="utf-8"?> <MESSAGES_LIST> <MESSAGE> <MESSAGE_TYPE>SHIP</MESSAGE_TYPE> <TB_ORDER_ID>1</TB_ORDER_ID> <TB_ORDER_ITEM_ID>1</TB_ORDER_ITEM_ID> <SKU>4689bls</SKU> <CHANNEL_SIGN>ebde</CHANNEL_SIGN> <CHANNEL_ORDER_ID>303-6862327-6937118</CHANNEL_ORDER_ID> <CHANNEL_ORDER_ITEM_ID>1</CHANNEL_ORDER_ITEM_ID> <QUANTITY>1</QUANTITY> <CARRIER_PARCEL_TYPE>DHL_STD_NATIONAL</CARRIER_PARCEL_TYPE> <IDCODE>854051100989</IDCODE> <IDCODE_RETURN_PROPOSAL>854051100990</IDCODE_RETURN_PROPOSAL> </MESSAGE> </MESSAGES_LIST> |
||
Response |
<?xml version="1.0" encoding="utf-8"?> <tradebyte> <state>message created successfully</state> </tradebyte> |
|
RETRIEVING MESSAGES
You can retrieve messages from TB.One for purposes of reviewing or verification.
Method |
GET |
Retrieves |
|---|---|---|
Target/Resource |
messages |
messages |
Parameter |
ORDER_ID |
for the order with the specified ID |
MESSAGE_TYPE |
retrieve messages of the specified type (e.g. RETURN, SHIP) |
|
Example |
https://rest.core.tradebyte.com/ACCOUNTNR/messages/? |
|
Response |
<?xml version="1.0" encoding="UTF-8"?> <MESSAGES_LIST> <MESSAGE> <MESSAGE_ID>326</MESSAGE_ID> <MESSAGE_TYPE>SHIP</MESSAGE_TYPE> <TB_ORDER_ID>15</TB_ORDER_ID> <TB_ORDER_ITEM_ID>21</TB_ORDER_ITEM_ID> <SKU>4712-34r</SKU> <CHANNEL_SIGN>ZADE</CHANNEL_SIGN> <CHANNEL_ORDER_ID>303-6862327-6937155</CHANNEL_ORDER_ID> <CHANNEL_ORDER_ITEM_ID>4712-34r</CHANNEL_ORDER_ITEM_ID> <CHANNEL_SKU>568423</CHANNEL_SKU> <QUANTITY>1</QUANTITY> <CARRIER_PARCEL_TYPE>DHL_STD_NATIONAL</CARRIER_PARCEL_TYPE> <IDCODE>236548951236</IDCODE> <IDCODE_RETURN_PROPOSAL>236548951237</IDCODE_RETURN_PROPOSAL> <COMMENT>Testkommentar</COMMENT> <PROCESSED>0</PROCESSED> <EXPORTED>0</EXPORTED> <DATE_CREATED>2014-03-21T16:12:57</DATE_CREATED> </MESSAGE> <MESSAGE>...</MESSAGE> </MESSAGES_LIST> |
|
For further information, see also:
•Order processing via REST - overview and status codes