Put an order on hold

Testing Env

https://statimlogistics-test.dsapp.io/integration

POST

/api/v1/orders/{orderId}/hold

Puts an order on hold. Note that Basic Authentication is required for all requests
as such, make sure to provide the Authorization header with a valid value.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

orderId

string

required

(Required)

Example:

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

text/plain

Body Params application/json

reasonId

string

required

exceptionCodeId

string

required

notes

string

required

Example

{
  "reasonId": "<string>",
  "exceptionCodeId": "<string>",
  "notes": "<string>"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://statimlogistics-test.dsapp.io/integration/api/v1/orders/<string>/hold' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "reasonId": "<string>",
  "exceptionCodeId": "<string>",
  "notes": "<string>"
}'

Responses

🟢200Order put on hold

text/plain

Body

object {0}

🟠400Order cannot be put on hold

🟠404Order not found

🔴500An error occurred when trying to put the order on hold

🟠403Forbidden

Modified at 2025-02-27 06:03:46

Get an order status

Add extra fees to an order