POST

set_order_shipping_completed

This method sets the order shipping status to completed.

Query parameters

action
string

Requested method

required
default : set_order_shipping_completed
shop_number
string

Your shop number. Example: “10123”

required
order_number
string

Order number. Example: “1012001234”

required
send_customer_email
boolean

Indicates whether an email about the event is to be sent to the customer. (Default = 0)

Response

application/json
object
error
integer

Error code 0 means no error.

required
error_text
string or null

Error message.

order_number
string

Order number. Example: “1010001596”

version
string

API version. Example: “1.0”

trace_id
string or null

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

Error Codes

Code Description
101 Unknown action
103 “shop_number” not set
110 Merchant not found
113 Shop not found
118 Missing parameters
123 Following parameters of wrong type: […]
201 Order not found
202 Order on hold
203 Order already completed
204 Order shipping status already on complete
400 Authorization not set
401 Authorization username invalid format
402 Generated authorization password invalid
403 Generated authorization is too old
404 The given OAuth2 access token is invalid
405 Shop has no rights to access API. Make sure your contract is valid
803 Internal error occurred while saving
999 Unknown error

Example

{
    error: 0,
    error_text: null,
    order_number: "1010001596",
    version: "1.0",
    trace_id: "spa-4f7ab2d146165"
}