OrderExternalStatus

Retrieve a specific order external status

get

Get details of a specific order external status by its ID.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Details of the specified order external status.

application/json

A model representing external statuses of an order with a name and unique code.

pkintegerRead-onlyOptional

Unique identifier for the order.

Example: 1

uuidstring · uuidOptional

The unique identifier for the external status.

Example: 123e4567-e89b-12d3-a456-426614174000

namestring · max: 64Required

The name of the external status.

Example: Shipped

codestring · max: 64Required

A unique code representing the external status.

Example: SHIPPED

modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z

created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/order_external_statuses/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/order_external_statuses/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED",
  "modified_date": "2021-07-07T14:00:00Z",
  "created_date": "2021-07-07T14:00:00Z"
}

Update order external status

put

Update an existing order external status.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

A model representing external statuses of an order with a name and unique code.

pkintegerRead-onlyOptional

Unique identifier for the order.

Example: 1

uuidstring · uuidOptional

The unique identifier for the external status.

Example: 123e4567-e89b-12d3-a456-426614174000

namestring · max: 64Required

The name of the external status.

Example: Shipped

codestring · max: 64Required

A unique code representing the external status.

Example: SHIPPED

modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z

created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z

Responses

200

The order external status updated successfully.

application/json

A model representing external statuses of an order with a name and unique code.

pkintegerRead-onlyOptional

Unique identifier for the order.

Example: 1

uuidstring · uuidOptional

The unique identifier for the external status.

Example: 123e4567-e89b-12d3-a456-426614174000

namestring · max: 64Required

The name of the external status.

Example: Shipped

codestring · max: 64Required

A unique code representing the external status.

Example: SHIPPED

modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z

created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

/api/v1/order_external_statuses/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/order_external_statuses/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED"
}

{
  "pk": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED",
  "modified_date": "2021-07-07T14:00:00Z",
  "created_date": "2021-07-07T14:00:00Z"
}

Delete order external status

delete

Delete a order external status.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

delete

/api/v1/order_external_statuses/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/order_external_statuses/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Update order external status

patch

Update an existing order external status.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

A model representing external statuses of an order with a name and unique code.

pkintegerRead-onlyOptional

Unique identifier for the order.

Example: 1

uuidstring · uuidOptional

The unique identifier for the external status.

Example: 123e4567-e89b-12d3-a456-426614174000

namestring · max: 64Required

The name of the external status.

Example: Shipped

codestring · max: 64Required

A unique code representing the external status.

Example: SHIPPED

modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z

created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z

Responses

200

The order external status updated successfully.

application/json

A model representing external statuses of an order with a name and unique code.

pkintegerRead-onlyOptional

Unique identifier for the order.

Example: 1

uuidstring · uuidOptional

The unique identifier for the external status.

Example: 123e4567-e89b-12d3-a456-426614174000

namestring · max: 64Required

The name of the external status.

Example: Shipped

codestring · max: 64Required

A unique code representing the external status.

Example: SHIPPED

modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z

created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/order_external_statuses/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v1/order_external_statuses/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED"
}

{
  "pk": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED",
  "modified_date": "2021-07-07T14:00:00Z",
  "created_date": "2021-07-07T14:00:00Z"
}

List order external statuses

get

Retrieve a paginated list of all order external statuses.

Authorizations

Token

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

uuidstringOptional

Filter by UUID.

Example: 123e4567-e89b-12d3-a456-426614174000

namestringOptional

Filter by name.

codestringOptional

Filter by code.

Responses

200

A paginated list of cargo companies.

application/json

countintegerOptional

Total number of cargo companies available.

nextstring · nullableOptional

URL of the next results page.

previousstring · nullableOptional

URL of the previous results page.

401

Unauthorized Access

application/json

403

Forbidden

500

Server Error

get

/api/v1/order_external_statuses/

HTTPcURLJavaScriptPython

GET /api/v1/order_external_statuses/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Shipped",
      "code": "SHIPPED",
      "modified_date": "2021-07-07T14:00:00Z",
      "created_date": "2021-07-07T14:00:00Z"
    }
  ]
}

Create a new order external status

post

Create a new order external status with the provided details.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

A model representing external statuses of an order with a name and unique code.

pkintegerRead-onlyOptional

Unique identifier for the order.

Example: 1

uuidstring · uuidOptional

The unique identifier for the external status.

Example: 123e4567-e89b-12d3-a456-426614174000

namestring · max: 64Required

The name of the external status.

Example: Shipped

codestring · max: 64Required

A unique code representing the external status.

Example: SHIPPED

modified_datestring · date-timeRead-onlyOptional

Modified Date

Example: 2021-07-07T14:00:00Z

created_datestring · date-timeRead-onlyOptional

Created Date

Example: 2021-07-07T14:00:00Z

Responses

201

The order external status was created successfully.

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/order_external_statuses/

HTTPcURLJavaScriptPython

POST /api/v1/order_external_statuses/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED"
}

{
  "pk": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Shipped",
  "code": "SHIPPED",
  "modified_date": "2021-07-07T14:00:00Z",
  "created_date": "2021-07-07T14:00:00Z"
}