Subscribe to order updates

Testing Env

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

POST

/api/v1/subscriptions

Subscribe to order updates. Every time an order is updated, the system will POST relevant data to
the specified URL. 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 *****************

Header Params

Content-Type

string

required

Example:

application/json

string

required

Example:

text/plain

Body Params application/json

eventTypes

array[string]

required

url

string

required

Example

{
  "eventTypes": [
    "<string>",
    "<string>"
  ],
  "url": "<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/subscriptions' \
--header 'Accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "eventTypes": [
    "<string>",
    "<string>"
  ],
  "url": "<string>"
}'

Responses

🟢200Subscription successful

text/plain

Body

object {0}

Example

{
    "subscriptionId": "string"
}

🟠400Subscription has missing/invalid values

🔴500An error occurred when trying to subscribe

🟠401Unauthorized

Modified at 2025-02-27 10:36:25

Get the subscriptions

Get the Order Item Userfields.