OrderComment

Retrieve order comment

get

Retrieve a specific order comment by ID

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

Order comment successfully retrieved

application/json
get
/api/v1/order_comments/{id}/

List order comments

get

List all order comments

Authorizations
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
idintegerOptional

Filters by id

ordernumberOptional

Filter by order ID.

Example: 123
commentstringOptional

Filter by comment

order_numberstringOptional

Filter by order number

Example: ORD123456
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
created_byintegerOptional

ID of the user who created the cancellation plan

Example: 1
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

order_idintegerOptional

Order ID

created_by_emailstringOptional

Filter by created by email

Responses
chevron-right
200

Order comments successfully listed

application/json
get
/api/v1/order_comments/

Create order comment

post

Create a new order comment

Authorizations
AuthorizationstringRequired
Body
Responses
post
/api/v1/order_comments/

Last updated

Was this helpful?