Cancellation Easy Return

Retrieve a Cancellation Easy Return record

get

Retrieve a specific Cancellation Easy Return record by ID.

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
chevron-right
200

Cancellation Easy Return record retrieved successfully

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

List Cancellation Easy Return records

get

Retrieve a paginated list of Cancellation Easy Return records.

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
codestringOptional

Filter by code.

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

start_date__gtstring · date-timeOptional

Filter for start_date greater than the specified date.

start_date__gtestring · date-timeOptional

Filter for start_date greater than or equal to the specified date.

start_date__ltstring · date-timeOptional

Filter for start_date less than the specified date.

start_date__ltestring · date-timeOptional

Filter for start_date less than or equal to the specified date.

start_date__date__gtstring · dateOptional

Filter for start_date date greater than the specified date.

start_date__date__gtestring · dateOptional

Filter for start_date date greater than or equal to the specified date.

start_date__date__ltstring · dateOptional

Filter for start_date date less than the specified date.

start_date__date__ltestring · dateOptional

Filter for start_date date less than or equal to the specified date.

end_date__gtstring · date-timeOptional

Filter for end_date greater than the specified date.

end_date__gtestring · date-timeOptional

Filter for end_date greater than or equal to the specified date.

end_date__ltstring · date-timeOptional

Filter for end_date less than the specified date.

end_date__ltestring · date-timeOptional

Filter for end_date less than or equal to the specified date.

end_date__date__gtstring · dateOptional

Filter for end_date date greater than the specified date.

end_date__date__gtestring · dateOptional

Filter for end_date date greater than or equal to the specified date.

end_date__date__ltstring · dateOptional

Filter for end_date date less than the specified date.

end_date__date__ltestring · dateOptional

Filter for end_date date less than or equal to the specified date.

max_count__gtintegerOptional
max_count__gteintegerOptional
max_count__ltintegerOptional
max_count__lteintegerOptional
shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:
statusstring · enumOptional

Status of the cancellation easy return.

Example: activePossible values:
Responses
chevron-right
200

Paginated list of Cancellation Easy Return records.

application/json
get
/api/v1/cancellation_easy_returns/

Last updated

Was this helpful?