POST

add_order_delivery_note

This method allows enables you to add adding delivery notes to an order.

Query parameters

action
string

Requested method

required
default: add_order_delivery_note
shop_number
string

Your shop number. Example: “10123”

required
order_number
string

Order number. Example: “1012001234”

required
shipping_service_id
string

Shipping service ID. Examples: “CITYLINK”, “DHL”, “USPS”, “UPS”

required
tracking_number
string

Tracking number. Example: “6645269AG9SFZ46”

mark_as_completed
boolean

Indicates whether an order is to be marked as completely or only partially shipped. (Default = 0)

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.

sma_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
119 “shipping_service_id” doesn’t exist
123 Following parameters of wrong type: […]
204 Order shipping status already completed
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,
    cancellation_number: "1010001596",
    version: "1.0",
    trace_id: "spa-4f7ab2d146165"
}