POST

update_order

With this action you can update an already existing Shopgate order in your shop system. In case that the order number is unknown, the action must be cancelled and the error reported.

Query parameters

action

string

Requested method

required

shop_number

string

Your shop number. Example: “11413”

required

order_number

string

Shopgate order number: Example: “1712000481”

payment

boolean

If this parameter is set to 1, the order’s payment information is updated.

shipping

boolean

If this parameter is set to 1, it will be checked whether the order is ready for shipping.

trace_id

string

Unique request trace ID. Example: “sma-9412”

required

Response

application/json

object

In case of an error

A JSON object including the error code, error text, API version and request trace ID is returned.

Otherwise a CSV file will be returned

error

integer

False means no error.

error_text

string or null

Error text; null means no error.

shopgate_library_version

string

Shopgate Library version. Example: “2.5.0”

plugin_version

string

Plugin version. Example: “2.5.3”

trace_id

string

Request trace-ID, needed as reference for contact Example: “sma-4f99573d74ae1”

external_order_number

string

Order number in your shop system. Example: “458323452”

external_order_id

string

Order id in your shop system. Example: “26345”

Error Codes

Code	Description
2	cannot open/create logfile(s)
10	invalid value in configuration
11	error reading or writing configuration
20	no action specified
21	unknown action requested
22	disabled action requested
23	wrong response format
30	parameter “order_number” missing
61	order not found
64	order status is “sent”
65	order is already up to date
83	database error
100	no connection to server
101	Unknown action
102	error code received from merchant API
120	authentication failed
999	Unknown error

Example

{
  "error": 0,
  "error_text": null,
  "shopgate_library_version": "2.1.0",
  "plugin_version": "2.1.0",
  "trace_id": "sma-3995",
  "external_order_id": "153003",
  "external_order_number": "141"
}