Order Item
Integration mapping types successfully retrieved
Type of integration mapping
Type of integration mapping
webPossible values: Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Order item mappings successfully retrieved
The date and time when the object was created.
The date and time when the object was last modified.
Associated content type id
Associated content type's object id value
Generic foreign key, handled dynamically
Code value of integration mapping
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Remote ID found successfully
123456123456789Unauthorized Access
The given resource or object was not found or does not exist.
Unique identifier of the resource
1Order Item retrieved successfully
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Order Item updated
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Order Item updated
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Order Item retrieved successfully with details
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Tracking URL for the item
Indicates if refund is forced
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Order Item retrieved successfully with details and integration mapping data
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Tracking URL for the item
Indicates if refund is forced
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1The sku of the new product to replace the current one.
Replaced Product of Order Item
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Updated order item send stock
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Tags retrieved successfully
tag1Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1Tag key to add to the object.
Tags added successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Unique identifier of the resource
1List of tag keys to add to the objects.
Tags added successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Unique identifier of the resource
1Tag key to add to the object.
Tags removed successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Unique identifier of the resource
1List of tag keys to add to the objects.
Tags removed successfully
No content
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
No content
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filters by id
Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by order item attributes
attributes__color=blueFilter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilter by order ID.
123Filter by Product ID.
123Enum meanings:
50- Cancellation Waiting100- Cancelled200- Waiting300- Payment Waiting350- Confirmation Waiting400- Approved450- Preparing500- Shipped510- Shipped and Informed520- Ready for Pickup540- Attempted to Delivery544- Review Started545- Review Waiting546- Waiting for Payment547- Paid550- Delivered600- Refunded
Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Invoice number associated with the cancellation plan
INV-123456Date of the invoice associated with the cancellation plan
2024-01-01T00:00:00ZFilter by e-archive URL.
Tracking number (case-insensitive)
Defined tracking URL (case-insensitive)
Shipping company options
yurticiPossible values: Filter by defined shipping company (case-insensitive).
Filter by Retail Price.
100Filter by image.
Filter by parent order item ID.
Filter by delivered date.
2024-01-01Filter by estimated delivery date.
2024-01-01Filter by shipped date.
2024-01-01Filter by Price List ID.
2Filter by Stock List ID.
2Filter by order external status ID
Filter by Shipping Option Group ID.
1Filter by carrier shipping code.
Filter by Transaction ID.
1Filter by Funds Transaction ID.
1Filter by Pay On Delivery Transaction ID.
1Filter by B2B Transaction ID.
1Filter by Loyalty Transaction ID.
1Filter by Cash Register Transaction ID.
1Filter by Reconciliation ID.
1Filter by Cancellation Reconciliation ID.
1Filter by cancel status
Filter by whether the order item has a forced refund.
trueFilter by installment interest amount.
Filter by discount amount
Filter by data source IDs.
Filter by the original stock ID associated with the order item.
1Filters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filters by mapping id
Filter(exact) by transaction ID
0Order ID
Filter by tag name.
Exclude by tag name.
Filter by key.
Tag to filter order items by.
Order items successfully listed
Total number of results.
URL of the next page of results.
URL of the previous page of results.
Unauthorized Access
Server Error
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filters by id
Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by order item attributes
attributes__color=blueFilter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilter by order ID.
123Filter by Product ID.
123Enum meanings:
50- Cancellation Waiting100- Cancelled200- Waiting300- Payment Waiting350- Confirmation Waiting400- Approved450- Preparing500- Shipped510- Shipped and Informed520- Ready for Pickup540- Attempted to Delivery544- Review Started545- Review Waiting546- Waiting for Payment547- Paid550- Delivered600- Refunded
Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Invoice number associated with the cancellation plan
INV-123456Date of the invoice associated with the cancellation plan
2024-01-01T00:00:00ZFilter by e-archive URL.
Tracking number (case-insensitive)
Defined tracking URL (case-insensitive)
Shipping company options
yurticiPossible values: Filter by defined shipping company (case-insensitive).
Filter by Retail Price.
100Filter by image.
Filter by parent order item ID.
Filter by delivered date.
2024-01-01Filter by estimated delivery date.
2024-01-01Filter by shipped date.
2024-01-01Filter by Price List ID.
2Filter by Stock List ID.
2Filter by order external status ID
Filter by Shipping Option Group ID.
1Filter by carrier shipping code.
Filter by Transaction ID.
1Filter by Funds Transaction ID.
1Filter by Pay On Delivery Transaction ID.
1Filter by B2B Transaction ID.
1Filter by Loyalty Transaction ID.
1Filter by Cash Register Transaction ID.
1Filter by Reconciliation ID.
1Filter by Cancellation Reconciliation ID.
1Filter by cancel status
Filter by whether the order item has a forced refund.
trueFilter by installment interest amount.
Filter by discount amount
Filter by data source IDs.
Filter by the original stock ID associated with the order item.
1Filters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filters by mapping id
Filter(exact) by transaction ID
0Order ID
Filter by tag name.
Exclude by tag name.
Exclude by key.
Tag to filter order items by.
Order items successfully listed
Total number of results.
URL of the next page of results.
URL of the previous page of results.
Unauthorized Access
Server Error
List of object IDs to which tags will be added.
List of tag keys to add to the objects.
Successfully added tags to order items
No content
Unauthorized Access
Server Error
No content
List of object IDs to which tags will be added.
List of tag keys to add to the objects.
Successfully removed tags from order items
No content
Unauthorized Access
Server Error
No content
Unique identifier of the resource
1The new weight value for the order item.
Reduced weight of Order Item
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filters by id
Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by order item attributes
attributes__color=blueFilter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilter by order ID.
123Filter by Product ID.
123Enum meanings:
50- Cancellation Waiting100- Cancelled200- Waiting300- Payment Waiting350- Confirmation Waiting400- Approved450- Preparing500- Shipped510- Shipped and Informed520- Ready for Pickup540- Attempted to Delivery544- Review Started545- Review Waiting546- Waiting for Payment547- Paid550- Delivered600- Refunded
Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Invoice number associated with the cancellation plan
INV-123456Date of the invoice associated with the cancellation plan
2024-01-01T00:00:00ZFilter by e-archive URL.
Tracking number (case-insensitive)
Defined tracking URL (case-insensitive)
Shipping company options
yurticiPossible values: Filter by defined shipping company (case-insensitive).
Filter by Retail Price.
100Filter by image.
Filter by parent order item ID.
Filter by delivered date.
2024-01-01Filter by estimated delivery date.
2024-01-01Filter by shipped date.
2024-01-01Filter by Price List ID.
2Filter by Stock List ID.
2Filter by order external status ID
Filter by Shipping Option Group ID.
1Filter by carrier shipping code.
Filter by Transaction ID.
1Filter by Funds Transaction ID.
1Filter by Pay On Delivery Transaction ID.
1Filter by B2B Transaction ID.
1Filter by Loyalty Transaction ID.
1Filter by Cash Register Transaction ID.
1Filter by Reconciliation ID.
1Filter by Cancellation Reconciliation ID.
1Filter by cancel status
Filter by whether the order item has a forced refund.
trueFilter by installment interest amount.
Filter by discount amount
Filter by data source IDs.
Filter by the original stock ID associated with the order item.
1Filters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filters by mapping id
Filter(exact) by transaction ID
0Order ID
Filter by tag name.
Exclude by tag name.
Order items successfully listed
Total number of results.
URL of the next page of results.
URL of the previous page of results.
Unauthorized Access
Server Error
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Order Item Created
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filters by id
Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by order item attributes
attributes__color=blueFilter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilter by order ID.
123Filter by Product ID.
123Enum meanings:
50- Cancellation Waiting100- Cancelled200- Waiting300- Payment Waiting350- Confirmation Waiting400- Approved450- Preparing500- Shipped510- Shipped and Informed520- Ready for Pickup540- Attempted to Delivery544- Review Started545- Review Waiting546- Waiting for Payment547- Paid550- Delivered600- Refunded
Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Invoice number associated with the cancellation plan
INV-123456Date of the invoice associated with the cancellation plan
2024-01-01T00:00:00ZFilter by e-archive URL.
Tracking number (case-insensitive)
Defined tracking URL (case-insensitive)
Shipping company options
yurticiPossible values: Filter by defined shipping company (case-insensitive).
Filter by Retail Price.
100Filter by image.
Filter by parent order item ID.
Filter by delivered date.
2024-01-01Filter by estimated delivery date.
2024-01-01Filter by shipped date.
2024-01-01Filter by Price List ID.
2Filter by Stock List ID.
2Filter by order external status ID
Filter by Shipping Option Group ID.
1Filter by carrier shipping code.
Filter by Transaction ID.
1Filter by Funds Transaction ID.
1Filter by Pay On Delivery Transaction ID.
1Filter by B2B Transaction ID.
1Filter by Loyalty Transaction ID.
1Filter by Cash Register Transaction ID.
1Filter by Reconciliation ID.
1Filter by Cancellation Reconciliation ID.
1Filter by cancel status
Filter by whether the order item has a forced refund.
trueFilter by installment interest amount.
Filter by discount amount
Filter by data source IDs.
Filter by the original stock ID associated with the order item.
1Filters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filters by mapping id
Filter(exact) by transaction ID
0Order ID
Filter by tag name.
Exclude by tag name.
Order items successfully listed
Total number of results.
URL of the next page of results.
URL of the previous page of results.
Unauthorized Access
Server Error
Specifies the page number of the current dataset
1Indicates the number of rows on the current page.
10Filters by id
Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
created_date__gt=2024-01-01T00:00:00ZFilter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).
modified_date__lt=2024-01-01T00:00:00ZFilter by order item attributes
attributes__color=blueFilter by attributes using additional keyword arguments.
attributes_kwargs__color=blueFilter by localized attributes in JSON format.
localized_attributes__locale=en-USFilter by localized attributes with additional keywords.
localized_attributes_kwargs__locale=en-GBFilter by order ID.
123Filter by Product ID.
123Enum meanings:
50- Cancellation Waiting100- Cancelled200- Waiting300- Payment Waiting350- Confirmation Waiting400- Approved450- Preparing500- Shipped510- Shipped and Informed520- Ready for Pickup540- Attempted to Delivery544- Review Started545- Review Waiting546- Waiting for Payment547- Paid550- Delivered600- Refunded
Currency type for the price list.
tryPossible values: Filter by the product price.
120Filter by Tax Rate.
18Invoice number associated with the cancellation plan
INV-123456Date of the invoice associated with the cancellation plan
2024-01-01T00:00:00ZFilter by e-archive URL.
Tracking number (case-insensitive)
Defined tracking URL (case-insensitive)
Shipping company options
yurticiPossible values: Filter by defined shipping company (case-insensitive).
Filter by Retail Price.
100Filter by image.
Filter by parent order item ID.
Filter by delivered date.
2024-01-01Filter by estimated delivery date.
2024-01-01Filter by shipped date.
2024-01-01Filter by Price List ID.
2Filter by Stock List ID.
2Filter by order external status ID
Filter by Shipping Option Group ID.
1Filter by carrier shipping code.
Filter by Transaction ID.
1Filter by Funds Transaction ID.
1Filter by Pay On Delivery Transaction ID.
1Filter by B2B Transaction ID.
1Filter by Loyalty Transaction ID.
1Filter by Cash Register Transaction ID.
1Filter by Reconciliation ID.
1Filter by Cancellation Reconciliation ID.
1Filter by cancel status
Filter by whether the order item has a forced refund.
trueFilter by installment interest amount.
Filter by discount amount
Filter by data source IDs.
Filter by the original stock ID associated with the order item.
1Filters by primary key
Filter by primary key greater than a specific value.
Filters by primary key greater than or equal to the given value
Filters by primary key less than the given value
Filters by primary key less than or equal to the given value
Filters by mapping id
Filter(exact) by transaction ID
0Order ID
Filter by tag name.
Exclude by tag name.
Order items successfully listed
Total number of results.
URL of the next page of results.
URL of the previous page of results.
Unauthorized Access
Server Error
Unique identifier of the resource
1The date and time when the object was created.
The date and time when the object was last modified.
Associated content type id
Associated content type's object id value
Generic foreign key, handled dynamically
Code value of integration mapping
Order item mapping object successfully created
The date and time when the object was created.
The date and time when the object was last modified.
Associated content type id
Associated content type's object id value
Generic foreign key, handled dynamically
Code value of integration mapping
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.
Unique identifier of the resource
1A JSON object containing extra fields for the order item.
Updated Extra Field of Order Item
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1The quantity of items waiting to be split. Must be at least 1.
Split Order Item
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Unique identifier of the resource
1The name of the source.
The original address information.
The ID of the original address.
The package number.
Created Order Item Easy Return Location
The date and time when the object was created.
The date and time when the object was last modified.
A JSON object to store various attributes of the entity.
{"key1":"value1","key2":"value2"}A JSON object to store additional attribute keyword arguments.
{"key1":"value1","key2":"value2"}A JSON object to store localized attributes.
{"name":{"en":"English","es":"Spanish"}}A JSON object to store localized attributes keyword arguments.
{"key":{"key1":"value1","key2":"value2"}}Order Item ID
Related order ID
1Related product ID
1Related price list ID
1Related stock list ID
1Status of the order item
waitingPossible values: Currency type for the price list.
tryPossible values: Price of the item
100Tax rate of the item
18Shipping company options
yurticiPossible values: Shipment code for the item
Cancellation status of the order item
waitingPossible values: Indicates if the item is tradable
Installment interest amount
Related data source ID
Related cancellation reconciliation ID
Related reconciliation ID
Indicates if refund is forced
Original stock ID
Related shipping option group ID
Extra field for additional data
Unauthorized Access
The given resource or object was not found or does not exist.
Server Error
Last updated
Was this helpful?