updateOrderStatus |
  
|
updateOrderStatus |
|
Update of order status.
This is a basic call to simplify the order status communication from an external system to Speed4Trade CONNECT. It allows to set the order status with a small amount of additional data for shipping, packaging and payment. The status is independent of the workflow type. Just transmit a status like ACKNOWLEDGED, PAID, or SHIPPED and Speed4Trade CONNECT will set the correct status and start several further standard or configured activities in the correct fitting workflow.
For additional Growth options see also the full updateOrderStatus call. |
<request method="updateOrderStatus" version="1.0.0"> <order significant_key="order_number_and_prefix"> <mandator_id>1</mandator_id> <order_number>100</order_number> <order_number_prefix>T2-</order_number_prefix> <status>ACKNOWLEDGED</status> <shipping_informations> <shipping_information> <tracking_number>32123461123</tracking_number> <shipping_provider_identifier>DHL</shipping_provider_identifier> <shipping_provider_external_id>dhl_ext</shipping_provider_external_id> </shipping_information> </shipping_informations> <payment_informations> <payment_information> <payment_status_id>1</payment_status_id><!-- Variant 1 --> <payment_status_identifier>unpaid</payment_status_identifier><!-- Variant 2 --> </payment_information> </payment_informations> </order> </request> |
Name |
Description |
Occ. |
Type |
Value Info |
|---|---|---|---|---|
request |
Root-Element of request |
1 |
Element |
|
method |
Attribute of request. Name of Webservice-Method. |
1 |
string |
fixed value: „updateOrderStatus“ |
version |
Attribute of request. Version control of request. |
1 |
integer |
fixed value: „1.0.0“ |
order |
Wrapper-Element, summarizing the data of an order. |
0..N |
Element |
|
significant_key |
Attribute of order.
For further alternatives see full call. Needs to be unique in external system.
|
1 |
string |
fixed values: "order_number" | "order_number_and_prefix" | "external_order_number_1" | "external_order_number_2" | "marketplace_order_id_1" | "marketplace_order_id_2" | "transaction_id_1" | "transaction_id_2" |
mandator_id |
client-ID |
1 |
integer |
|
order_number |
order number |
0..1 |
integer |
|
order_number_prefix |
order number prefix, if order number is not unique |
0..1 |
string |
|
status |
order status |
1 |
string |
fixed values: "FETCHED" | "PAID" | "SHIPPED" | "CANCELED" | "ACKNOWLEDGED" |
shipping_informations |
Wrapper-Element, summarizing all shipping information. |
0..1 |
Element |
|
shipping_information |
Wrapper-Element, summarizing a package information. |
1..N |
Element |
|
tracking_number |
tracking number of delivery service |
1 |
string |
|
shipping_provider_identifier |
Shipping provider identifier |
0..1 |
string |
|
shipping_provider_external_id |
Shipping provider id defined by your external system |
0..1 |
string |
|
payment_informations |
Wrapper-Element, summarizing all payment information |
0..1 |
Element |
|
payment_information |
Wrapper-Element, summarizing one payment information |
1..N |
Element |
|
payment_status_id |
payment status id |
0..1 |
integer |
|
payment_status_identifier |
payment status identifier |
0..1 |
string |
|
acknowledgement_informations |
Wrapper-Element, summarizing all acknowledgement information |
0..1 |
Element |
|
acknowledgement_information |
Wrapper-Element, summarizing one acknowledgement information |
1..N |
Element |
|
export_time |
external system export date | documents with date/time stamp that and when external system successfully retrieved the order. Used together with status "ACKNOWLEDGED" |
1 |
date |
<response method="updateOrderStatus" version="1.0.0"> <report return_code="<0"> <error_description>Detailed Error Description in the language of the mandator language setting</error_description> </report> </response> |
Name |
Description |
Occ. |
Type |
Value Info |
|---|---|---|---|---|
response |
Root-element of response |
1 |
Element |
|
method |
Attribute of response. Name of Webservice-Method. |
1 |
string |
fixed value: „updateOrderStatus“ |
version |
Attribute of response. Version control of request. |
1 |
integer |
fixed value: „1.0.0“ |
report |
Information about executed operation. A report element is returned for each requested order element. |
0..N |
Element |
|
return_code |
Attribute of report. Identifies error reason code. |
1 |
integer |
0 = OK. < 0 = error |
error_description |
Describes errors and error reasons of executed operation, once appeared. |
0..1 |
string |
•The status "ACKNOWLEDGED" is used to set the ERP export flag. If this flag is set, the order won't be included in the next ERP export, if the export was triggered by an user via the frontend. Furthermore the users in the frontend can use the flag to identify when the ERP system acknowledged the order. It can be combined with the field export_time within an acknowledgement_information element. If no acknowledgement_information element is specified, then the current time will be used. •When transferring a new order status, additional status specific information can be added. Status specific information cannot be added after a status change. Sample: Payment Information can only be transmitted when setting the status to "PAID". Shipping information only with the status change to "SHIPPED". Transfering payment or shipping information after an order already hat the relevant status, the information will be ignored. •You can transmit multiple instances of payment and shipping information. Updates or deletions are not possible. With updateOrders you have additional options to transfer order status related information. •Orders with order status identifier regrouped or canceled cannot be updated with this call. •If you like to transfer package data , you need to use shipping_provider_identifier or shipping_provider_external_id. •Don't use marketplace_order_id_1 nor marketplace_order_id_2 as significant_key for eBay orders, because this fields will change their values after checkout is completed. |
Version |
Change Description |
|---|---|
4.8.46 |
Introduction of a Basic "Simplified" Integration |
4.9.7 |
New status "ACKNOWLEDGED" and associated element "acknowledgement_informations" added. |
4.9.28 |
New note text for marketplace_order_id_1 and marketplace_order_id_2 for eBay orders. |
4.10.48 |
Packages can now be transferred with a shipping date and return number. |