SalesChannelOrderShippingInfo

PreviousIntegrationActions NextSalesChannelBatchRequests

Was this helpful?

Retrieve Order Shipping Info

get

Retrieve detailed information about a specific order shipping info.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

application/json

404

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

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/order_shipping_infos/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "order": 1,
  "shipping_company": "yurtici",
  "send_request": "text",
  "send_response": {},
  "is_send": true,
  "cargo_label": "https://example.com",
  "shipping_option_group": 1,
  "created_date": "2025-05-22T10:47:54.742Z",
  "modified_date": "2025-05-22T10:47:54.742Z"
}

Lists channel related all of order shipping info data

get

Lists channel related all of order shipping info data

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

order__created_datestringOptional

Filter by order creation date with lookup expressions (e.g., gte, lte).

Example: order__created_date__gte=2024-01-01

order__modified_datestringOptional

Filter by order modification date with lookup expressions (e.g., gte, lte).

Example: order__modified_date__gte=2024-01-01

order__statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Example: order__status=shippedPossible values:

order__shipping_addressstringOptional

Filter by order shipping address.

Example: order__shipping_address=1

order__billing_addressstringOptional

Filter by order billing address.

Example: order__billing_address=1

order__currencystring · enumOptional

Filter by order currency.

Example: order__currency=usdPossible values:

order__amountstringOptional

Filter by order amount.

Example: order__amount=100.00

order__discount_amountstringOptional

Filter by order discount amount.

Example: order__discount_amount=10.00

order__shipping_amountstringOptional

Filter by order shipping amount.

Example: order__shipping_amount=5.00

order__shipping_tax_ratestringOptional

Filter by order shipping tax rate.

Example: order__shipping_tax_rate=0.18

order__refund_amountstringOptional

Filter by order refund amount.

Example: order__refund_amount=0.00

order__discount_refund_amountstringOptional

Filter by order discount refund amount.

Example: order__discount_refund_amount=0.00

order__shipping_refund_amountstringOptional

Filter by order shipping refund amount.

Example: order__shipping_refund_amount=0.00

order__invoice_datestringOptional

Filter by order invoice date.

Example: order__invoice_date=2024-01-01

order__tracking_numberstringOptional

Filter by order tracking number.

Example: order__tracking_number=123456789

order__remote_addrstringOptional

Filter by order remote address.

order__has_gift_boxbooleanOptional

Filter by order gift box status.

order__channelstringOptional

Filter by order channel.

Example: order__channel=1

order__customerstringOptional

Filter by order customer.

Example: order__customer=1

order__date_placedstringOptional

Filter by order date placed.

Example: order__date_placed=2024-01-01

order__extra_fieldstringOptional

Filter by order extra field.

order__installmentstringOptional

Filter by order installment.

order__installment_countstringOptional

Filter by order installment count.

order__installment_interest_amountstringOptional

Filter by order installment interest amount.

order__cargo_companystringOptional

Filter by order cargo company.

order__is_sendbooleanOptional

Filter by order send status.

order__cancellation_infostringOptional

Filter by order cancellation info.

order__shipping_interest_amountstringOptional

Filter by order shipping interest amount.

order__external_statusstringOptional

Filter by order external status.

order__client_typestring · enumOptional

Filter by order client type.

Possible values:

order__checkout_provider_idnumberOptional

Filter by order checkout provider ID.

order__installment_freestringOptional

Filter by order installment free status.

order__pknumberOptional

Filter by order primary key.

order__pk__gtnumberOptional

Filter by order primary key greater than a specific value.

order__pk__gtenumberOptional

Filter by order primary key greater than or equal to a specific value.

order__pk__ltnumberOptional

Filter by order primary key less than a specific value.

order__pk__ltenumberOptional

Filter by order primary key less than or equal to a specific value.

order__has_gift_nodestringOptional

Filter by order gift node.

order__orderitem__cancel_statusstring · enumOptional

Filter by order item cancel status.

Possible values:

order__orderitem__statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Possible values:

order__e_archive_url__isnullstringOptional

Filter by whether the e-archive URL is null.

order__invoice_number__isnullstringOptional

Filter by whether the invoice number is null.

order__skustringOptional

Filter by order SKU.

order__base_codestringOptional

Filter by order base code.

order__posstringOptional

Filter by order POS.

order__number__exactstringOptional

Filter by exact order number.

order__cancellation_plan_statusstring · enumOptional

Filter by order cancellation plan status.

Possible values:

order__coupon_codestringOptional

Filter by order coupon code.

order__data_sourcestringOptional

Filter by order data source.

order__vendororder__isnullstringOptional

Filter by whether the vendor order is null.

order__succeeded_transactionstringOptional

Filter by succeeded transaction.

order__brand_exactstringOptional

Filter by exact brand.

order__waiting_capturestringOptional

Filter by waiting capture.

order__erp_codestringOptional

Filter by ERP code.

order__mapping__created_datestringOptional

Filter by mapping creation date.

Example: order__mapping__created_date=2024-01-01

order__mapping__modified_datestringOptional

Filter by mapping modification date.

Example: order__mapping__modified_date=2024-01-01

order__mapping__content_typestringOptional

Filter by order content type.

Example: order__mapping__content_type=1

order__mapping__object_idstringOptional

Filter by order object ID.

Example: order__mapping__object_id=1

order__mapping__integration_typestring · enumOptional

Filter by order integration type.

Possible values:

order__mapping__pkstringOptional

Filter by order mapping primary key.

order__mapping__pk__gtstringOptional

Filter by order mapping primary key greater than a specific value.

order__mapping__pk__gtestringOptional

Filter by order mapping primary key greater than or equal to a specific value.

order__mapping__pk__ltstringOptional

Filter by order mapping primary key less than a specific value.

order__mapping__pk__ltestringOptional

Filter by order mapping primary key less than or equal to a specific value.

order__mapping__code__exactstringOptional

Filter by exact order mapping code.

order__customer__created_datestringOptional

Filter by customer creation date.

Example: order__customer__created_date=2024-01-01

order__customer__modified_datestringOptional

Filter by customer modification date.

Example: order__customer__modified_date=2024-01-01

order__customer__attributesstringOptional

Filter by customer attributes.

order__customer__channelstringOptional

Filter by customer channel.

order__customer__is_activestringOptional

Filter by customer active status.

order__customer__channel_codestringOptional

Filter by customer channel code.

order__customer__extra_fieldstringOptional

Filter by customer extra field.

order__customer__email_allowedstringOptional

Filter by customer email allowed status.

order__customer__sms_allowedstringOptional

Filter by customer SMS allowed status.

order__customer__call_allowedstringOptional

Filter by customer call allowed status.

order__customer__date_joinedstring · date-timeOptional

Filter by customer date joined.

Example: order__customer__date_joined=2024-01-01

order__customer__date_of_birthstring · dateOptional

Filter by customer date of birth.

Example: order__customer__date_of_birth=2024-01-01

order__customer__pkstringOptional

Filter by customer primary key.

order__customer__pk__gtstringOptional

Filter by customer primary key greater than a specific value.

order__customer__pk__gtestringOptional

Filter by customer primary key greater than or equal to a specific value.

order__customer__pk__ltstringOptional

Filter by customer primary key less than a specific value.

order__customer__pk__ltestringOptional

Filter by customer primary key less than or equal to a specific value.

order__discountitem__created_datestringOptional

Filter by discount item creation date.

Example: order__discountitem__created_date=2024-01-01

order__discountitem__modified_datestringOptional

Filter by discount item modification date.

Example: order__discountitem__modified_date=2024-01-01

order__discountitem__amountstringOptional

Filter by discount item amount.

Example: order__discountitem__amount=10.00

order__discountitem__orderstringOptional

Filter by discount item order.

Example: order__discountitem__order=1

order__discountitem__cancel_amountstringOptional

Filter by discount item cancel amount.

Example: order__discountitem__cancel_amount=0.00

order__discountitem__promotionstringOptional

Filter by discount item promotion.

order__discountitem__data_source_discount_sharing_ratestringOptional

Filter by discount item data source discount sharing rate.

order__discountitem__pkstringOptional

Filter by discount item primary key.

order__discountitem__pk__gtstringOptional

Filter by discount item primary key greater than a specific value.

order__discountitem__pk__gtestringOptional

Filter by discount item primary key greater than or equal to a specific value.

order__discountitem__pk__ltstringOptional

Filter by discount item primary key less than a specific value.

order__discountitem__pk__ltestringOptional

Filter by discount item primary key less than or equal to a specific value.

order__external_status__created_datestringOptional

Filter by external status creation date.

Example: order__external_status__created_date=2024-01-01

order__external_status__modified_datestringOptional

Filter by external status modification date.

Example: order__external_status__modified_date=2024-01-01

order__external_status__uuidstringOptional

Filter by external status UUID.

order__external_status__pkstringOptional

Filter by external status primary key.

order__external_status__pk__gtstringOptional

Filter by external status primary key greater than a specific value.

order__external_status__pk__gtestringOptional

Filter by external status primary key greater than or equal to a specific value.

order__external_status__pk__ltstringOptional

Filter by external status primary key less than a specific value.

order__external_status__pk__ltestringOptional

Filter by external status primary key less than or equal to a specific value.

order__billing_address__created_datestringOptional

Filter by billing address creation date.

Example: order__billing_address__created_date=2024-01-01

order__billing_address__modified_datestringOptional

Filter by billing address modification date.

Example: order__billing_address__modified_date=2024-01-01

order__billing_address__is_activestringOptional

Filter by billing address active status.

order__billing_address__notesstringOptional

Filter by billing address notes.

order__billing_address__e_bill_tax_payerstringOptional

Filter by billing address e-bill tax payer.

order__billing_address__countrystringOptional

Filter by billing address country.

order__billing_address__citystringOptional

Filter by billing address city.

order__billing_address__townshipstringOptional

Filter by billing address township.

order__billing_address__districtstringOptional

Filter by billing address district.

order__billing_address__retail_storestringOptional

Filter by billing address retail store.

order__billing_address__extra_fieldstringOptional

Filter by billing address extra field.

order__billing_address__customerstringOptional

Filter by billing address customer.

order__billing_address__pkstringOptional

Filter by billing address primary key.

order__billing_address__pk__gtstringOptional

Filter by billing address primary key greater than a specific value.

order__billing_address__pk__gtestringOptional

Filter by billing address primary key greater than or equal to a specific value.

order__billing_address__pk__ltstringOptional

Filter by billing address primary key less than a specific value.

order__billing_address__pk__ltestringOptional

Filter by billing address primary key less than or equal to a specific value.

order__billing_address__hash_data_exactstringOptional

Filter by exact billing address hash data.

order__shipping_address__created_datestringOptional

Filter by shipping address creation date.

Example: order__shipping_address__created_date=2024-01-01

order__shipping_address__modified_datestringOptional

Filter by shipping address modification date.

Example: order__shipping_address__modified_date=2024-01-01

order__shipping_address__is_activestringOptional

Filter by shipping address active status.

order__shipping_address__notesstringOptional

Filter by shipping address notes.

order__shipping_address__e_bill_tax_payerstringOptional

Filter by shipping address e-bill tax payer.

order__shipping_address__countrystringOptional

Filter by shipping address country.

order__shipping_address__citystringOptional

Filter by shipping address city.

order__shipping_address__townshipstringOptional

Filter by shipping address township.

order__shipping_address__districtstringOptional

Filter by shipping address district.

order__shipping_address__retail_storestringOptional

Filter by shipping address retail store.

order__shipping_address__extra_fieldstringOptional

Filter by shipping address extra field.

order__shipping_address__customerstringOptional

Filter by shipping address customer.

order__shipping_address__pkstringOptional

Filter by shipping address primary key.

order__shipping_address__pk__gtstringOptional

Filter by shipping address primary key greater than a specific value.

order__shipping_address__pk__gtestringOptional

Filter by shipping address primary key greater than or equal to a specific value.

order__shipping_address__pk__ltstringOptional

Filter by shipping address primary key less than a specific value.

order__shipping_address__pk__ltestringOptional

Filter by shipping address primary key less than or equal to a specific value.

order__shipping_address__hash_data_exactstringOptional

Filter by exact shipping address hash data.

order__billing_address__mapping__created_datestringOptional

Filter by billing address mapping creation date.

Example: order__billing_address__mapping__created_date=2024-01-01

order__billing_address__mapping__modified_datestringOptional

Filter by billing address mapping modification date.

Example: order__billing_address__mapping__modified_date=2024-01-01

order__billing_address__mapping__content_typestringOptional

Filter by billing address mapping content type.

Example: order__billing_address__mapping__content_type=1

order__billing_address__mapping__object_idstringOptional

Filter by billing address mapping object ID.

Example: order__billing_address__mapping__object_id=1

order__billing_address__mapping__integration_typestring · enumOptional

Filter by billing address mapping integration type.

Possible values:

order__billing_address__mapping__pkstringOptional

Filter by billing address mapping primary key.

order__billing_address__mapping__pk__gtstringOptional

Filter by billing address mapping primary key greater than a specific value.

order__billing_address__mapping__pk__gtestringOptional

Filter by billing address mapping primary key greater than or equal to a specific value.

order__billing_address__mapping__pk__ltstringOptional

Filter by billing address mapping primary key less than a specific value.

order__billing_address__mapping__pk__ltestringOptional

Filter by billing address mapping primary key less than or equal to a specific value.

order__billing_address__mapping__code__exactstringOptional

Filter by exact billing address mapping code.

order__shipping_address__mapping__created_datestringOptional

Filter by shipping address mapping creation date.

Example: order__shipping_address__mapping__created_date=2024-01-01

order__shipping_address__mapping__modified_datestringOptional

Filter by shipping address mapping modification date.

Example: order__shipping_address__mapping__modified_date=2024-01-01

order__shipping_address__mapping__content_typestringOptional

Filter by shipping address mapping content type.

Example: order__shipping_address__mapping__content_type=1

order__shipping_address__mapping__object_idstringOptional

Filter by shipping address mapping object ID.

Example: order__shipping_address__mapping__object_id=1

order__shipping_address__mapping__integration_typestring · enumOptional

Filter by shipping address mapping integration type.

Possible values:

order__shipping_address__mapping__pkstringOptional

Filter by shipping address mapping primary key.

order__shipping_address__mapping__pk__gtstringOptional

Filter by shipping address mapping primary key greater than a specific value.

order__shipping_address__mapping__pk__gtestringOptional

Filter by shipping address mapping primary key greater than or equal to a specific value.

order__shipping_address__mapping__pk__ltstringOptional

Filter by shipping address mapping primary key less than a specific value.

order__shipping_address__mapping__pk__ltestringOptional

Filter by shipping address mapping primary key less than or equal to a specific value.

order__shipping_address__mapping__code__exactstringOptional

Filter by exact shipping address mapping code.

order__billing_address__customer__created_datestringOptional

Filter by billing address's customer creation date.

Example: order__billing_address__customer__created_date=2024-01-01

order__billing_address__customer__modified_datestringOptional

Filter by billing address's customer modification date.

Example: order__billing_address__customer__modified_date=2024-01-01

order__billing_address__customer__attributesstringOptional

Filter by billing address's customer attributes.

order__billing_address__customer__channelstringOptional

Filter by billing address's customer channel.

order__billing_address__customer__is_activestringOptional

Filter by billing address's customer active status.

order__billing_address__customer__channel_codestringOptional

Filter by billing address's customer channel code.

order__billing_address__customer__extra_fieldstringOptional

Filter by billing address's customer extra field.

order__billing_address__customer__email_allowedstringOptional

Filter by billing address's customer email allowed status.

order__billing_address__customer__sms_allowedstringOptional

Filter by billing address's customer SMS allowed status.

order__billing_address__customer__call_allowedstringOptional

Filter by billing address's customer call allowed status.

order__billing_address__customer__date_joinedstring · date-timeOptional

Filter by billing address's customer date joined.

Example: order__billing_address__customer__date_joined=2024-01-01

order__billing_address__customer__date_of_birthstring · dateOptional

Filter by billing address's customer date of birth.

Example: order__billing_address__customer__date_of_birth=2024-01-01

order__billing_address__customer__pkstringOptional

Filter by billing address's customer primary key.

order__billing_address__customer__pk__gtstringOptional

Filter by billing address's customer primary key greater than a specific value.

order__billing_address__customer__pk__gtestringOptional

Filter by billing address's customer primary key greater than or equal to a specific value.

order__billing_address__customer__pk__ltstringOptional

Filter by billing address's customer primary key less than a specific value.

order__billing_address__customer__pk__ltestringOptional

Filter by billing address's customer primary key less than or equal to a specific value.

order__shipping_address__customer__created_datestringOptional

Filter by shipping address's customer creation date.

Example: order__shipping_address__customer__created_date=2024-01-01

order__shipping_address__customer__modified_datestringOptional

Filter by shipping address's customer modification date.

Example: order__shipping_address__customer__modified_date=2024-01-01

order__shipping_address__customer__attributesstringOptional

Filter by shipping address's customer attributes.

order__shipping_address__customer__channelstringOptional

Filter by shipping address's customer channel.

order__shipping_address__customer__is_activestringOptional

Filter by shipping address's customer active status.

order__shipping_address__customer__channel_codestringOptional

Filter by shipping address's customer channel code.

order__shipping_address__customer__extra_fieldstringOptional

Filter by shipping address's customer extra field.

order__shipping_address__customer__email_allowedstringOptional

Filter by shipping address's customer email allowed status.

order__shipping_address__customer__sms_allowedstringOptional

Filter by shipping address's customer SMS allowed status.

order__shipping_address__customer__call_allowedstringOptional

Filter by shipping address's customer call allowed status.

order__shipping_address__customer__date_joinedstring · date-timeOptional

Filter by shipping address's customer date joined.

Example: order__shipping_address__customer__date_joined=2024-01-01

order__shipping_address__customer__date_of_birthstring · dateOptional

Filter by shipping address's customer date of birth.

Example: order__shipping_address__customer__date_of_birth=2024-01-01

order__shipping_address__customer__pkstringOptional

Filter by shipping address's customer primary key.

order__shipping_address__customer__pk__gtstringOptional

Filter by shipping address's customer primary key greater than a specific value.

order__shipping_address__customer__pk__gtestringOptional

Filter by shipping address's customer primary key greater than or equal to a specific value.

order__shipping_address__customer__pk__ltstringOptional

Filter by shipping address's customer primary key less than a specific value.

order__shipping_address__customer__pk__ltestringOptional

Filter by shipping address's customer primary key less than or equal to a specific value.

order__billing_address__country__created_datestringOptional

Filter by billing address's country creation date.

Example: order__billing_address__country__created_date=2024-01-01

order__billing_address__country__modified_datestringOptional

Filter by billing address's country modification date.

Example: order__billing_address__country__modified_date=2024-01-01

order__billing_address__country__is_activestringOptional

Filter by billing address's country active status.

order__billing_address__country__pkstringOptional

Filter by billing address's country primary key.

order__billing_address__country__pk__gtstringOptional

Filter by billing address's country primary key greater than a specific value.

order__billing_address__country__pk__gtestringOptional

Filter by billing address's country primary key greater than or equal to a specific value.

order__billing_address__country__pk__ltstringOptional

Filter by billing address's country primary key less than a specific value.

order__billing_address__country__pk__ltestringOptional

Filter by billing address's country primary key less than or equal to a specific value.

order__billing_address__country__name__exactstringOptional

Filter by exact billing address's country name.

order__billing_address__country__code__exactstringOptional

Filter by exact billing address's country code.

order__shipping_address__country__created_datestringOptional

Filter by shipping address's country creation date.

Example: order__shipping_address__country__created_date=2024-01-01

order__shipping_address__country__modified_datestringOptional

Filter by shipping address's country modification date.

Example: order__shipping_address__country__modified_date=2024-01-01

order__shipping_address__country__is_activestringOptional

Filter by shipping address's country active status.

order__shipping_address__country__pkstringOptional

Filter by shipping address's country primary key.

order__shipping_address__country__pk__gtstringOptional

Filter by shipping address's country primary key greater than a specific value.

order__shipping_address__country__pk__gtestringOptional

Filter by shipping address's country primary key greater than or equal to a specific value.

order__shipping_address__country__pk__ltstringOptional

Filter by shipping address's country primary key less than a specific value.

order__shipping_address__country__pk__ltestringOptional

Filter by shipping address's country primary key less than or equal to a specific value.

order__shipping_address__country__name__exactstringOptional

Filter by exact shipping address's country name.

order__shipping_address__country__code__exactstringOptional

Filter by exact shipping address's country code.

order__billing_address__city__created_datestringOptional

Filter by billing address's city creation date.

Example: order__billing_address__city__created_date=2024-01-01

order__billing_address__city__modified_datestringOptional

Filter by billing address's city modification date.

Example: order__billing_address__city__modified_date=2024-01-01

order__billing_address__city__is_activestringOptional

Filter by billing address's city active status.

order__billing_address__city__country__created_datestringOptional

Filter by billing address's city country creation date.

Example: order__billing_address__city__country__created_date=2024-01-01

order__billing_address__city__country__modified_datestringOptional

Filter by billing address's city country modification date.

Example: order__billing_address__city__country__modified_date=2024-01-01

order__billing_address__city__country__is_activestringOptional

Filter by billing address's city country active status.

order__billing_address__city__country__pkstringOptional

Filter by billing address's city country primary key.

order__billing_address__city__country__pk__gtstringOptional

Filter by billing address's city country primary key greater than a specific value.

order__billing_address__city__country__pk__gtestringOptional

Filter by billing address's city country primary key greater than or equal to a specific value.

order__billing_address__city__country__pk__ltstringOptional

Filter by billing address's city country primary key less than a specific value.

order__billing_address__city__country__pk__ltestringOptional

Filter by billing address's city country primary key less than or equal to a specific value.

order__billing_address__city__country__mapping__created_datestringOptional

Filter by billing address's city country mapping creation date.

Example: order__billing_address__city__country__mapping__created_date=2024-01-01

order__billing_address__city__country__mapping__modified_datestringOptional

Filter by billing address's city country mapping modification date.

Example: order__billing_address__city__country__mapping__modified_date=2024-01-01

order__billing_address__city__country__mapping__content_typestringOptional

Filter by billing address's city country mapping content type.

Example: order__billing_address__city__country__mapping__content_type=1

order__billing_address__city__country__mapping__object_idstringOptional

Filter by billing address's city country mapping object ID.

Example: order__billing_address__city__country__mapping__object_id=1

order__billing_address__city__country__mapping__integration_typestring · enumOptional

Filter by billing address's city country mapping integration type.

Possible values:

order__billing_address__city__country__mapping__pkstringOptional

Filter by billing address's city country mapping primary key.

order__billing_address__city__country__mapping__pk__gtstringOptional

Filter by billing address's city country mapping primary key greater than a specific value.

order__billing_address__city__country__mapping__pk__gtestringOptional

Filter by billing address's city country mapping primary key greater than or equal to a specific value.

order__billing_address__city__country__mapping__pk__ltstringOptional

Filter by billing address's city country mapping primary key less than a specific value.

order__billing_address__city__country__mapping__pk__ltestringOptional

Filter by billing address's city country mapping primary key less than or equal to a specific value.

order__billing_address__city__country__mapping__code__exactstringOptional

Filter by exact billing address's city country mapping code.

order__billing_address__city__country__name__exactstringOptional

Filter by exact billing address's city country name.

order__billing_address__city__country__code__exactstringOptional

Filter by exact billing address's city country code.

order__billing_address__city__country__prioritystringOptional

Filter by billing address's city country priority.

order_shipping_address__city__created_datestringOptional

Filter by shipping address's city creation date.

Example: order__shipping_address__city__created_date=2024-01-01

order__shipping_address__city__modified_datestringOptional

Filter by shipping address's city modification date.

Example: order__shipping_address__city__modified_date=2024-01-01

order__shipping_address__city__is_activestringOptional

Filter by shipping address's city active status.

order__shipping_address__city__country__created_datestringOptional

Filter by shipping address's city country creation date.

Example: order__shipping_address__city__country__created_date=2024-01-01

order__shipping_address__city__country__modified_datestringOptional

Filter by shipping address's city country modification date.

Example: order__shipping_address__city__country__modified_date=2024-01-01

order__shipping_address__city__country__is_activestringOptional

Filter by shipping address's city country active status.

order__shipping_address__city__country__pkstringOptional

Filter by shipping address's city country primary key.

order__shipping_address__city__country__pk__gtstringOptional

Filter by shipping address's city country primary key greater than a specific value.

order__shipping_address__city__country__pk__gtestringOptional

Filter by shipping address's city country primary key greater than or equal to a specific value.

order__shipping_address__city__country__pk__ltstringOptional

Filter by shipping address's city country primary key less than a specific value.

order__shipping_address__city__country__pk__ltestringOptional

Filter by shipping address's city country primary key less than or equal to a specific value.

order__shipping_address__city__country__mapping__created_datestringOptional

Filter by shipping address's city country mapping creation date.

Example: order__shipping_address__city__country__mapping__created_date=2024-01-01

order__shipping_address__city__country__mapping__modified_datestringOptional

Filter by shipping address's city country mapping modification date.

Example: order__shipping_address__city__country__mapping__modified_date=2024-01-01

order__shipping_address__city__country__mapping__content_typestringOptional

Filter by shipping address's city country mapping content type.

Example: order__shipping_address__city__country__mapping__content_type=1

order__shipping_address__city__country__mapping__object_idstringOptional

Filter by shipping address's city country mapping object ID.

Example: order__shipping_address__city__country__mapping__object_id=1

order__shipping_address__city__country__mapping__integration_typestring · enumOptional

Filter by shipping address's city country mapping integration type.

Possible values:

order__shipping_address__city__country__mapping__pkstringOptional

Filter by shipping address's city country mapping primary key.

order__shipping_address__city__country__mapping__pk__gtstringOptional

Filter by shipping address's city country mapping primary key greater than a specific value.

order__shipping_address__city__country__mapping__pk__gtestringOptional

Filter by shipping address's city country mapping primary key greater than or equal to a specific value.

order__shipping_address__city__country__mapping__pk__ltstringOptional

Filter by shipping address's city country mapping primary key less than a specific value.

order__shipping_address__city__country__mapping__pk__ltestringOptional

Filter by shipping address's city country mapping primary key less than or equal to a specific value.

order__shipping_address__city__country__mapping__code__exactstringOptional

Filter by exact shipping address's city country mapping code.

order__shipping_address__city__country__name__exactstringOptional

Filter by exact shipping address's city country name.

order__shipping_address__city__country__code__exactstringOptional

Filter by exact shipping address's city country code.

order__shipping_address__city__country__prioritystringOptional

Filter by shipping address's city country priority.

order__billing_address__township__created_datestringOptional

Filter by billing address's township creation date.

Example: order__billing_address__township__created_date=2024-01-01

order__billing_address__township__modified_datestringOptional

Filter by billing address's township modification date.

Example: order__billing_address__township__modified_date=2024-01-01

order__billing_address__township__translationsstringOptional

Filter by billing address's township translations.

order__billing_address__township__is_activestringOptional

Filter by billing address's township active status.

order__billing_address__township__citystringOptional

Filter by billing address's township city.

order__billing_address__township__pkstringOptional

Filter by billing address's township primary key.

order__billing_address__township__pk__gtstringOptional

Filter by billing address's township primary key greater than a specific value.

order__billing_address__township__pk__gtestringOptional

Filter by billing address's township primary key greater than or equal to a specific value.

order__billing_address__township__pk__ltstringOptional

Filter by billing address's township primary key less than a specific value.

order__billing_address__township__pk__ltestringOptional

Filter by billing address's township primary key less than or equal to a specific value.

order__billing_address__township__mapping__created_datestringOptional

Filter by billing address's township mapping creation date.

Example: order__billing_address__township__mapping__created_date=2024-01-01

order__billing_address__township__mapping__modified_datestringOptional

Filter by billing address's township mapping modification date.

Example: order__billing_address__township__mapping__modified_date=2024-01-01

order__billing_address__township__mapping__content_typestringOptional

Filter by billing address's township mapping content type.

Example: order__billing_address__township__mapping__content_type=1

order__billing_address__township__mapping__object_idstringOptional

Filter by billing address's township mapping object ID.

Example: order__billing_address__township__mapping__object_id=1

order__billing_address__township__mapping__integration_typestring · enumOptional

Filter by billing address's township mapping integration type.

Possible values:

order__billing_address__township__mapping__pkstringOptional

Filter by billing address's township mapping primary key.

order__billing_address__township__mapping__pk__gtstringOptional

Filter by billing address's township mapping primary key greater than a specific value.

order__billing_address__township__mapping__pk__gtestringOptional

Filter by billing address's township mapping primary key greater than or equal to a specific value.

order__billing_address__township__mapping__pk__ltstringOptional

Filter by billing address's township mapping primary key less than a specific value.

order__billing_address__township__mapping__pk__ltestringOptional

Filter by billing address's township mapping primary key less than or equal to a specific value.

order__billing_address__township__mapping__code__exactstringOptional

Filter by exact billing address's township mapping code.

order__billing_address__township__name__exactstringOptional

Filter by exact billing address's township name.

order__shipping_address__township__created_datestringOptional

Filter by shipping address's township creation date.

Example: order__shipping_address__township__created_date=2024-01-01

order__shipping_address__township__modified_datestringOptional

Filter by shipping address's township modification date.

Example: order__shipping_address__township__modified_date=2024-01-01

order__shipping_address__township__translationsstringOptional

Filter by shipping address's township translations.

order__shipping_address__township__is_activestringOptional

Filter by shipping address's township active status.

order__shipping_address__township__citystringOptional

Filter by shipping address's township city.

order__shipping_address__township__pkstringOptional

Filter by shipping address's township primary key.

order__shipping_address__township__pk__gtstringOptional

Filter by shipping address's township primary key greater than a specific value.

order__shipping_address__township__pk__gtestringOptional

Filter by shipping address's township primary key greater than or equal to a specific value.

order__shipping_address__township__pk__ltstringOptional

Filter by shipping address's township primary key less than a specific value.

order__shipping_address__township__pk__ltestringOptional

Filter by shipping address's township primary key less than or equal to a specific value.

order__shipping_address__township__mapping__created_datestringOptional

Filter by shipping address's township mapping creation date.

Example: order__shipping_address__township__mapping__created_date=2024-01-01

order__shipping_address__township__mapping__modified_datestringOptional

Filter by shipping address's township mapping modification date.

Example: order__shipping_address__township__mapping__modified_date=2024-01-01

order__shipping_address__township__mapping__content_typestringOptional

Filter by shipping address's township mapping content type.

Example: order__shipping_address__township__mapping__content_type=1

order__shipping_address__township__mapping__object_idstringOptional

Filter by shipping address's township mapping object ID.

Example: order__shipping_address__township__mapping__object_id=1

order__shipping_address__township__mapping__integration_typestring · enumOptional

Filter by shipping address's township mapping integration type.

Possible values:

order__shipping_address__township__mapping__pkstringOptional

Filter by shipping address's township mapping primary key.

order__shipping_address__township__mapping__pk__gtstringOptional

Filter by shipping address's township mapping primary key greater than a specific value.

order__shipping_address__township__mapping__pk__gtestringOptional

Filter by shipping address's township mapping primary key greater than or equal to a specific value.

order__shipping_address__township__mapping__pk__ltstringOptional

Filter by shipping address's township mapping primary key less than a specific value.

order__shipping_address__township__mapping__pk__ltestringOptional

Filter by shipping address's township mapping primary key less than or equal to a specific value.

order__shipping_address__township__mapping__code__exactstringOptional

Filter by exact shipping address's township mapping code.

order__shipping_address__township__name__exactstringOptional

Filter by exact shipping address's township name.

order__billing_address__district__created_datestringOptional

Filter by billing address's district creation date.

Example: order__billing_address__district__created_date=2024-01-01

order__billing_address__district__modified_datestringOptional

Filter by billing address's district modification date.

Example: order__billing_address__district__modified_date=2024-01-01

order__billing_address__district__translationsstringOptional

Filter by billing address's district translations.

order__billing_address__district__is_activestringOptional

Filter by billing address's district active status.

order__billing_address__district__citystringOptional

Filter by billing address's district city.

order__billing_address__district__townshipstringOptional

Filter by billing address's district township.

order__billing_address__district__pkstringOptional

Filter by billing address's district primary key.

order__billing_address__district__pk__gtstringOptional

Filter by billing address's district primary key greater than a specific value.

order__billing_address__district__pk__gtestringOptional

Filter by billing address's district primary key greater than or equal to a specific value.

order__billing_address__district__pk__ltstringOptional

Filter by billing address's district primary key less than a specific value.

order__billing_address__district__pk__ltestringOptional

Filter by billing address's district primary key less than or equal to a specific value.

order__billing_address__district__mapping__created_datestringOptional

Filter by billing address's district mapping creation date.

Example: order__billing_address__district__mapping__created_date=2024-01-01

order__billing_address__district__mapping__modified_datestringOptional

Filter by billing address's district mapping modification date.

Example: order__billing_address__district__mapping__modified_date=2024-01-01

order__billing_address__district__mapping__content_typestringOptional

Filter by billing address's district mapping content type.

Example: order__billing_address__district__mapping__content_type=1

order__billing_address__district__mapping__object_idstringOptional

Filter by billing address's district mapping object ID.

Example: order__billing_address__district__mapping__object_id=1

order__billing_address__district__mapping__integration_typestring · enumOptional

Filter by billing address's district mapping integration type.

Possible values:

order__billing_address__district__mapping__pkstringOptional

Filter by billing address's district mapping primary key.

order__billing_address__district__mapping__pk__gtstringOptional

Filter by billing address's district mapping primary key greater than a specific value.

order__billing_address__district__mapping__pk__gtestringOptional

Filter by billing address's district mapping primary key greater than or equal to a specific value.

order__billing_address__district__mapping__pk__ltstringOptional

Filter by billing address's district mapping primary key less than a specific value.

order__billing_address__district__mapping__pk__ltestringOptional

Filter by billing address's district mapping primary key less than or equal to a specific value.

order__billing_address__district__mapping__code__exactstringOptional

Filter by exact billing address's district mapping code.

order__billing_address__district__name__exactstringOptional

Filter by exact billing address's district name.

order__shipping_address__district__created_datestringOptional

Filter by shipping address's district creation date.

Example: order__shipping_address__district__created_date=2024-01-01

order__shipping_address__district__modified_datestringOptional

Filter by shipping address's district modification date.

Example: order__shipping_address__district__modified_date=2024-01-01

order__shipping_address__district__translationsstringOptional

Filter by shipping address's district translations.

order__shipping_address__district__is_activestringOptional

Filter by shipping address's district active status.

order__shipping_address__district__citystringOptional

Filter by shipping address's district city.

order__shipping_address__district__townshipstringOptional

Filter by shipping address's district township.

order__shipping_address__district__pkstringOptional

Filter by shipping address's district primary key.

order__shipping_address__district__pk__gtstringOptional

Filter by shipping address's district primary key greater than a specific value.

order__shipping_address__district__pk__gtestringOptional

Filter by shipping address's district primary key greater than or equal to a specific value.

order__shipping_address__district__pk__ltstringOptional

Filter by shipping address's district primary key less than a specific value.

order__shipping_address__district__pk__ltestringOptional

Filter by shipping address's district primary key less than or equal to a specific value.

order__shipping_address__district__mapping__created_datestringOptional

Filter by shipping address's district mapping creation date.

Example: order__shipping_address__district__mapping__created_date=2024-01-01

order__shipping_address__district__mapping__modified_datestringOptional

Filter by shipping address's district mapping modification date.

Example: order__shipping_address__district__mapping__modified_date=2024-01-01

order__shipping_address__district__mapping__content_typestringOptional

Filter by shipping address's district mapping content type.

Example: order__shipping_address__district__mapping__content_type=1

order__shipping_address__district__mapping__object_idstringOptional

Filter by shipping address's district mapping object ID.

Example: order__shipping_address__district__mapping__object_id=1

order__shipping_address__district__mapping__integration_typestring · enumOptional

Filter by shipping address's district mapping integration type.

Possible values:

order__shipping_address__district__mapping__pkstringOptional

Filter by shipping address's district mapping primary key.

order__shipping_address__district__mapping__pk__gtstringOptional

Filter by shipping address's district mapping primary key greater than a specific value.

order__shipping_address__district__mapping__pk__gtestringOptional

Filter by shipping address's district mapping primary key greater than or equal to a specific value.

order__shipping_address__district__mapping__pk__ltstringOptional

Filter by shipping address's district mapping primary key less than a specific value.

order__shipping_address__district__mapping__pk__ltestringOptional

Filter by shipping address's district mapping primary key less than or equal to a specific value.

order__shipping_address__district__mapping__code__exactstringOptional

Filter by exact shipping address's district mapping code.

order__shipping_address__district__name__exactstringOptional

Filter by exact shipping address's district name.

order__billing_address__retail_store__created_datestringOptional

Filter by billing address's retail store creation date.

Example: order__billing_address__retail_store__created_date=2024-01-01

order__billing_address__retail_store__modified_datestringOptional

Filter by billing address's retail store modification date.

Example: order__billing_address__retail_store__modified_date=2024-01-01

order__billing_address__retail_store__namestringOptional

Filter by billing address's retail store name.

order__billing_address__retail_store__townshipstringOptional

Filter by billing address's retail store township.

order__billing_address__retail_store__districtstringOptional

Filter by billing address's retail store district.

order__billing_address__retail_store__addressstringOptional

Filter by billing address's retail store address.

order__billing_address__retail_store__latitudestringOptional

Filter by billing address's retail store latitude.

order__billing_address__retail_store__longitudestringOptional

Filter by billing address's retail store longitude.

order__billing_address__retail_store__is_activestringOptional

Filter by billing address's retail store active status.

order__billing_address__retail_store__click_and_collectstringOptional

Filter by billing address's retail store click and collect status.

order__billing_address__retail_store__kapida_enabledstringOptional

Filter by billing address's retail store kapida enabled status.

order__billing_address__retail_store__fast_deliverystringOptional

Filter by billing address's retail store fast delivery status.

order__billing_address__retail_store__store_typestringOptional

Filter by billing address's retail store type.

order__billing_address__retail_store__querystringOptional

Filter by billing address's retail store query.

order__billing_address__retail_store__groupstringOptional

Filter by billing address's retail store group.

order__billing_address__retail_store__related_retail_storesstringOptional

Filter by billing address's retail store related retail stores.

order__billing_address__retail_store__sort_orderstringOptional

Filter by billing address's retail store sort order.

order__billing_address__retail_store__is_return_acceptedstringOptional

Filter by billing address's retail store return accepted status.

order__billing_address__retail_store__channelsstringOptional

Filter by billing address's retail store channels.

order__billing_address__retail_store__pkstringOptional

Filter by billing address's retail store primary key.

order__billing_address__retail_store__pk__gtstringOptional

Filter by billing address's retail store primary key greater than a specific value.

order__billing_address__retail_store__pk__gtestringOptional

Filter by billing address's retail store primary key greater than or equal to a specific value.

order__billing_address__retail_store__pk__ltstringOptional

Filter by billing address's retail store primary key less than a specific value.

order__billing_address__retail_store__pk__ltestringOptional

Filter by billing address's retail store primary key less than or equal to a specific value.

order__billing_address__retail_store__erp_codestringOptional

Filter by billing address's retail store ERP code.

order__billing_address__retail_store__erp_code_iexactstringOptional

Filter by billing address's retail store ERP code (case insensitive).

order__billing_address__retail_store__erp_code__instringOptional

Filter by billing address's retail store ERP code (in a list).

order__billing_address__retail_store__integration_typestring · enumOptional

Filter by billing address's retail store integration type.

Possible values:

order__billing_address__retail_store__related_retail_store_excludestringOptional

Filter by billing address's retail store related retail store exclude.

order__billing_address__retail_store__retail_store_excludestringOptional

Filter by billing address's retail store retail store exclude.

order__shipping_address__retail_store__created_datestringOptional

Filter by shipping address's retail store creation date.

Example: order__shipping_address__retail_store__created_date=2024-01-01

order__shipping_address__retail_store__modified_datestringOptional

Filter by shipping address's retail store modification date.

Example: order__shipping_address__retail_store__modified_date=2024-01-01

order__shipping_address__retail_store__namestringOptional

Filter by shipping address's retail store name.

order__shipping_address__retail_store__townshipstringOptional

Filter by shipping address's retail store township.

order__shipping_address__retail_store__districtstringOptional

Filter by shipping address's retail store district.

order__shipping_address__retail_store__addressstringOptional

Filter by shipping address's retail store address.

order__shipping_address__retail_store__latitudestringOptional

Filter by shipping address's retail store latitude.

order__shipping_address__retail_store__longitudestringOptional

Filter by shipping address's retail store longitude.

order__shipping_address__retail_store__is_activestringOptional

Filter by shipping address's retail store active status.

order__shipping_address__retail_store__click_and_collectstringOptional

Filter by shipping address's retail store click and collect status.

order__shipping_address__retail_store__kapida_enabledstringOptional

Filter by shipping address's retail store kapida enabled status.

order__shipping_address__retail_store__fast_deliverystringOptional

Filter by shipping address's retail store fast delivery status.

order__shipping_address__retail_store__store_typestringOptional

Filter by shipping address's retail store type.

order__shipping_address__retail_store__querystringOptional

Filter by shipping address's retail store query.

order__shipping_address__retail_store__groupstringOptional

Filter by shipping address's retail store group.

order__shipping_address__retail_store__related_retail_storesstringOptional

Filter by shipping address's retail store related retail stores.

order__shipping_address__retail_store__sort_orderstringOptional

Filter by shipping address's retail store sort order.

order__shipping_address__retail_store__is_return_acceptedstringOptional

Filter by shipping address's retail store return accepted status.

order__shipping_address__retail_store__channelsstringOptional

Filter by shipping address's retail store channels.

order__shipping_address__retail_store__pkstringOptional

Filter by shipping address's retail store primary key.

order__shipping_address__retail_store__pk__gtstringOptional

Filter by shipping address's retail store primary key greater than a specific value.

order__shipping_address__retail_store__pk__gtestringOptional

Filter by shipping address's retail store primary key greater than or equal to a specific value.

order__shipping_address__retail_store__pk__ltstringOptional

Filter by shipping address's retail store primary key less than a specific value.

order__shipping_address__retail_store__pk__ltestringOptional

Filter by shipping address's retail store primary key less than or equal to a specific value.

order__shipping_address__retail_store__erp_codestringOptional

Filter by shipping address's retail store ERP code.

order__shipping_address__retail_store__erp_code_iexactstringOptional

Filter by shipping address's retail store ERP code (case insensitive).

order__shipping_address__retail_store__erp_code__instringOptional

Filter by shipping address's retail store ERP code (in a list).

order__shipping_address__retail_store__integration_typestring · enumOptional

Filter by shipping address's retail store integration type.

Possible values:

order__shipping_address__retail_store__related_retail_store_excludestringOptional

Filter by shipping address's retail store related retail store exclude.

order__shipping_address__retail_store__retail_store_excludestringOptional

Filter by shipping address's retail store retail store exclude.

order__billing_address__retail_store__country__created_datestringOptional

Filter by billing address's country creation date.

Example: order__billing_address__retail_store__country__created_date=2024-01-01

order__billing_address__retail_store__country__modified_datestringOptional

Filter by billing address's country modification date.

Example: order__billing_address__retail_store__country__modified_date=2024-01-01

order__billing_address__retail_store__country__is_activestringOptional

Filter by billing address's country active status.

order__billing_address__retail_store__country__pkstringOptional

Filter by billing address's country primary key.

order__billing_address__retail_store__country__pk__gtstringOptional

Filter by billing address's country primary key greater than a specific value.

order__billing_address__retail_store__country__pk__gtestringOptional

Filter by billing address's country primary key greater than or equal to a specific value.

order__billing_address__retail_store__country__pk__ltstringOptional

Filter by billing address's country primary key less than a specific value.

order__billing_address__retail_store__country__pk__ltestringOptional

Filter by billing address's country primary key less than or equal to a specific value.

order__billing_address__retail_store__country__name__exactstringOptional

Filter by exact billing address's country name.

order__billing_address__retail_store__country__code__exactstringOptional

Filter by exact billing address's country code.

order__shipping_address__retail_store__country__created_datestringOptional

Filter by shipping address's country creation date.

Example: order__shipping_address__retail_store__country__created_date=2024-01-01

order__shipping_address__retail_store__country__modified_datestringOptional

Filter by shipping address's country modification date.

Example: order__shipping_address__retail_store__country__modified_date=2024-01-01

order__shipping_address__retail_store__country__is_activestringOptional

Filter by shipping address's country active status.

order__shipping_address__retail_store__country__pkstringOptional

Filter by shipping address's country primary key.

order__shipping_address__retail_store__country__pk__gtstringOptional

Filter by shipping address's country primary key greater than a specific value.

order__shipping_address__retail_store__country__pk__gtestringOptional

Filter by shipping address's country primary key greater than or equal to a specific value.

order__shipping_address__retail_store__country__pk__ltstringOptional

Filter by shipping address's country primary key less than a specific value.

order__shipping_address__retail_store__country__pk__ltestringOptional

Filter by shipping address's country primary key less than or equal to a specific value.

order__shipping_address__retail_store__country__name__exactstringOptional

Filter by exact shipping address's country name.

order__shipping_address__retail_store__country__code__exactstringOptional

Filter by exact shipping address's country code.

order__billing_address__retail_store__city__created_datestringOptional

Filter by billing address's city creation date.

Example: order__billing_address__retail_store__city__created_date=2024-01-01

order__billing_address__retail_store__city__modified_datestringOptional

Filter by billing address's city modification date.

Example: order__billing_address__retail_store__city__modified_date=2024-01-01

order__billing_address__retail_store__city__is_activestringOptional

Filter by billing address's city active status.

order__billing_address__retail_store__city__country__created_datestringOptional

Filter by billing address's city country creation date.

Example: order__billing_address__retail_store__city__country__created_date=2024-01-01

order__billing_address__retail_store__city__country__modified_datestringOptional

Filter by billing address's city country modification date.

Example: order__billing_address__retail_store__city__country__modified_date=2024-01-01

order__billing_address__retail_store__city__country__is_activestringOptional

Filter by billing address's city country active status.

order__billing_address__retail_store__city__country__pkstringOptional

Filter by billing address's city country primary key.

order__billing_address__retail_store__city__country__pk__gtstringOptional

Filter by billing address's city country primary key greater than a specific value.

order__billing_address__retail_store__city__country__pk__gtestringOptional

Filter by billing address's city country primary key greater than or equal to a specific value.

order__billing_address__retail_store__city__country__pk__ltstringOptional

Filter by billing address's city country primary key less than a specific value.

order__billing_address__retail_store__city__country__pk__ltestringOptional

Filter by billing address's city country primary key less than or equal to a specific value.

order__billing_address__retail_store__city__country__mapping__created_datestringOptional

Filter by billing address's city country mapping creation date.

Example: order__billing_address__retail_store__city__country__mapping__created_date=2024-01-01

order__billing_address__retail_store__city__country__mapping__modified_datestringOptional

Filter by billing address's city country mapping modification date.

Example: order__billing_address__retail_store__city__country__mapping__modified_date=2024-01-01

order__billing_address__retail_store__city__country__mapping__content_typestringOptional

Filter by billing address's city country mapping content type.

Example: order__billing_address__retail_store__city__country__mapping__content_type=1

order__billing_address__retail_store__city__country__mapping__object_idstringOptional

Filter by billing address's city country mapping object ID.

Example: order__billing_address__retail_store__city__country__mapping__object_id=1

order__billing_address__retail_store__city__country__mapping__integration_typestring · enumOptional

Filter by billing address's city country mapping integration type.

Possible values:

order__billing_address__retail_store__city__country__mapping__pkstringOptional

Filter by billing address's city country mapping primary key.

order__billing_address__retail_store__city__country__mapping__pk__gtstringOptional

Filter by billing address's city country mapping primary key greater than a specific value.

order__billing_address__retail_store__city__country__mapping__pk__gtestringOptional

Filter by billing address's city country mapping primary key greater than or equal to a specific value.

order__billing_address__retail_store__city__country__mapping__pk__ltstringOptional

Filter by billing address's city country mapping primary key less than a specific value.

order__billing_address__retail_store__city__country__mapping__pk__ltestringOptional

Filter by billing address's city country mapping primary key less than or equal to a specific value.

order__billing_address__retail_store__city__country__mapping__code__exactstringOptional

Filter by exact billing address's city country mapping code.

order__billing_address__retail_store__city__country__name__exactstringOptional

Filter by exact billing address's city country name.

order__billing_address__retail_store__city__country__code__exactstringOptional

Filter by exact billing address's city country code.

order__billing_address__retail_store__city__country__prioritystringOptional

Filter by billing address's city country priority.

order__shipping_address__retail_store__city__created_datestringOptional

Filter by shipping address's city creation date.

Example: order__shipping_address__retail_store__city__created_date=2024-01-01

order__shipping_address__retail_store__city__modified_datestringOptional

Filter by shipping address's city modification date.

Example: order__shipping_address__retail_store__city__modified_date=2024-01-01

order__shipping_address__retail_store__city__is_activestringOptional

Filter by shipping address's city active status.

order__shipping_address__retail_store__city__country__created_datestringOptional

Filter by shipping address's city country creation date.

Example: order__shipping_address__retail_store__city__country__created_date=2024-01-01

order__shipping_address__retail_store__city__country__modified_datestringOptional

Filter by shipping address's city country modification date.

Example: order__shipping_address__retail_store__city__country__modified_date=2024-01-01

order__shipping_address__retail_store__city__country__is_activestringOptional

Filter by shipping address's city country active status.

order__shipping_address__retail_store__city__country__pkstringOptional

Filter by shipping address's city country primary key.

order__shipping_address__retail_store__city__country__pk__gtstringOptional

Filter by shipping address's city country primary key greater than a specific value.

order__shipping_address__retail_store__city__country__pk__gtestringOptional

Filter by shipping address's city country primary key greater than or equal to a specific value.

order__shipping_address__retail_store__city__country__pk__ltstringOptional

Filter by shipping address's city country primary key less than a specific value.

order__shipping_address__retail_store__city__country__pk__ltestringOptional

Filter by shipping address's city country primary key less than or equal to a specific value.

order__shipping_address__retail_store__city__country__mapping__created_datestringOptional

Filter by shipping address's city country mapping creation date.

Example: order__shipping_address__retail_store__city__country__mapping__created_date=2024-01-01

order__shipping_address__retail_store__city__country__mapping__modified_datestringOptional

Filter by shipping address's city country mapping modification date.

Example: order__shipping_address__retail_store__city__country__mapping__modified_date=2024-01-01

order__shipping_address__retail_store__city__country__mapping__content_typestringOptional

Filter by shipping address's city country mapping content type.

Example: order__shipping_address__retail_store__city__country__mapping__content_type=1

order__shipping_address__retail_store__city__country__mapping__object_idstringOptional

Filter by shipping address's city country mapping object ID.

Example: order__shipping_address__retail_store__city__country__mapping__object_id=1

order__shipping_address__retail_store__city__country__mapping__integration_typestring · enumOptional

Filter by shipping address's city country mapping integration type.

Possible values:

order__shipping_address__retail_store__city__country__mapping__pkstringOptional

Filter by shipping address's city country mapping primary key.

order__shipping_address__retail_store__city__country__mapping__pk__gtstringOptional

Filter by shipping address's city country mapping primary key greater than a specific value.

order__shipping_address__retail_store__city__country__mapping__pk__gtestringOptional

Filter by shipping address's city country mapping primary key greater than or equal to a specific value.

order__shipping_address__retail_store__city__country__mapping__pk__ltstringOptional

Filter by shipping address's city country mapping primary key less than a specific value.

order__shipping_address__retail_store__city__country__mapping__pk__ltestringOptional

Filter by shipping address's city country mapping primary key less than or equal to a specific value.

order__shipping_address__retail_store__city__country__mapping__code__exactstringOptional

Filter by exact shipping address's city country mapping code.

order__shipping_address__retail_store__city__country__name__exactstringOptional

Filter by exact shipping address's city country name.

order__shipping_address__retail_store__city__country__code__exactstringOptional

Filter by exact shipping address's city country code.

order__shipping_address__retail_store__city__country__prioritystringOptional

Filter by shipping address's city country priority.

Responses

200

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

GET /api/v1/channel/{channel_id}/order_shipping_infos/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "previous": "https://example.com",
  "next": "https://example.com",
  "results": []
}

Lists channel related all of order shipping info data

get

Lists channel related all of order shipping info data

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

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

order__created_datestringOptional

Filter by order creation date with lookup expressions (e.g., gte, lte).

Example: order__created_date__gte=2024-01-01

order__modified_datestringOptional

Filter by order modification date with lookup expressions (e.g., gte, lte).

Example: order__modified_date__gte=2024-01-01

order__statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded

Example: order__status=shippedPossible values:

order__shipping_addressstringOptional

Filter by order shipping address.

Example: order__shipping_address=1

order__billing_addressstringOptional

Filter by order billing address.

Example: order__billing_address=1

order__currencystring · enumOptional

Filter by order currency.

Example: order__currency=usdPossible values:

order__amountstringOptional

Filter by order amount.

Example: order__amount=100.00

order__discount_amountstringOptional

Filter by order discount amount.

Example: order__discount_amount=10.00

order__shipping_amountstringOptional

Filter by order shipping amount.

Example: order__shipping_amount=5.00

order__shipping_tax_ratestringOptional

Filter by order shipping tax rate.

Example: order__shipping_tax_rate=0.18

order__refund_amountstringOptional

Filter by order refund amount.

Example: order__refund_amount=0.00

order__discount_refund_amountstringOptional

Filter by order discount refund amount.

Example: order__discount_refund_amount=0.00

order__shipping_refund_amountstringOptional

Filter by order shipping refund amount.

Example: order__shipping_refund_amount=0.00

order__invoice_datestringOptional

Filter by order invoice date.

Example: order__invoice_date=2024-01-01

order__tracking_numberstringOptional

Filter by order tracking number.

Example: order__tracking_number=123456789

order__remote_addrstringOptional

Filter by order remote address.

order__has_gift_boxbooleanOptional

Filter by order gift box status.

order__channelstringOptional

Filter by order channel.

Example: order__channel=1

order__customerstringOptional

Filter by order customer.

Example: order__customer=1

order__date_placedstringOptional

Filter by order date placed.

Example: order__date_placed=2024-01-01

order__extra_fieldstringOptional

Filter by order extra field.

order__installmentstringOptional

Filter by order installment.

order__installment_countstringOptional

Filter by order installment count.

order__installment_interest_amountstringOptional

Filter by order installment interest amount.

order__cargo_companystringOptional

Filter by order cargo company.

order__is_sendbooleanOptional

Filter by order send status.

order__cancellation_infostringOptional

Filter by order cancellation info.

order__shipping_interest_amountstringOptional

Filter by order shipping interest amount.

order__external_statusstringOptional

Filter by order external status.

order__client_typestring · enumOptional

Filter by order client type.

Possible values:

order__checkout_provider_idnumberOptional

Filter by order checkout provider ID.

order__installment_freestringOptional

Filter by order installment free status.

order__pknumberOptional

Filter by order primary key.

order__pk__gtnumberOptional

Filter by order primary key greater than a specific value.

order__pk__gtenumberOptional

Filter by order primary key greater than or equal to a specific value.

order__pk__ltnumberOptional

Filter by order primary key less than a specific value.

order__pk__ltenumberOptional

Filter by order primary key less than or equal to a specific value.

order__has_gift_nodestringOptional

Filter by order gift node.

order__orderitem__cancel_statusstring · enumOptional

Filter by order item cancel status.

Possible values:

order__orderitem__statusstring · enumOptional

Enum meanings:

50 - Cancellation Waiting
100 - Cancelled
200 - Waiting
300 - Payment Waiting
350 - Confirmation Waiting
400 - Approved
450 - Preparing
500 - Shipped
510 - Shipped and Informed
520 - Ready for Pickup
540 - Attempted to Delivery
544 - Review Started
545 - Review Waiting
546 - Waiting for Payment
547 - Paid
550 - Delivered
600 - Refunded