c6dff873de
* update dependencies * update onboarding mdx * fixes for mdx issues * fixes for mdx compatibility * resolve mdx errors * fixes in reference * fix check errors * revert change in vale action * fix node version in action * fix summary in markdown
1156 lines
34 KiB
Plaintext
1156 lines
34 KiB
Plaintext
---
|
|
displayed_sidebar: entitiesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# ClaimItem
|
|
|
|
A claim item is an item created as part of a claim. It references an item in the order that should be exchanged or refunded.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "claim_order",
|
|
"type": "[ClaimOrder](ClaimOrder.mdx)",
|
|
"description": "The details of the claim this item belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": [
|
|
{
|
|
"name": "additional_items",
|
|
"type": "[LineItem](LineItem.mdx)[]",
|
|
"description": "The details of the new items to be shipped when the claim's type is `replace`",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "canceled_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the claim was canceled.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "claim_items",
|
|
"type": "[ClaimItem](ClaimItem.mdx)[]",
|
|
"description": "The details of the items that should be replaced or refunded.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "deleted_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was deleted.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "fulfillment_status",
|
|
"type": "[ClaimFulfillmentStatus](../enums/ClaimFulfillmentStatus.mdx)",
|
|
"description": "The claim's fulfillment status",
|
|
"optional": false,
|
|
"defaultValue": "not_fulfilled",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "fulfillments",
|
|
"type": "[Fulfillment](Fulfillment.mdx)[]",
|
|
"description": "The fulfillments of the new items to be shipped",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The claim's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "idempotency_key",
|
|
"type": "`string`",
|
|
"description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "metadata",
|
|
"type": "`Record<string, unknown>`",
|
|
"description": "An optional key-value map with additional details",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "no_notification",
|
|
"type": "`boolean`",
|
|
"description": "Flag for describing whether or not notifications related to this should be send.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order",
|
|
"type": "[Order](Order.mdx)",
|
|
"description": "The details of the order that this claim was created for.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the order that the claim comes from.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "payment_status",
|
|
"type": "[ClaimPaymentStatus](../enums/ClaimPaymentStatus.mdx)",
|
|
"description": "The status of the claim's payment",
|
|
"optional": false,
|
|
"defaultValue": "na",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "refund_amount",
|
|
"type": "`number`",
|
|
"description": "The amount that will be refunded in conjunction with the claim",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "return_order",
|
|
"type": "[Return](Return.mdx)",
|
|
"description": "The details of the return associated with the claim if the claim's type is `replace`.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "shipping_address",
|
|
"type": "[Address](Address.mdx)",
|
|
"description": "The details of the address that new items should be shipped to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "shipping_address_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the address that the new items should be shipped to",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "shipping_methods",
|
|
"type": "[ShippingMethod](ShippingMethod.mdx)[]",
|
|
"description": "The details of the shipping methods that the claim order will be shipped with.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "type",
|
|
"type": "[ClaimType](../enums/ClaimType.mdx)",
|
|
"description": "The claim's type",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "claim_order_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the claim this item is associated with.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "deleted_at",
|
|
"type": "``null`` \\| `Date`",
|
|
"description": "The date with timezone at which the resource was deleted.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The claim item's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "images",
|
|
"type": "[ClaimImage](ClaimImage.mdx)[]",
|
|
"description": "The claim images that are attached to the claim item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": [
|
|
{
|
|
"name": "claim_item",
|
|
"type": "[ClaimItem](ClaimItem.mdx)",
|
|
"description": "The details of the claim item this image is associated with.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "claim_item_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the claim item associated with the image",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "deleted_at",
|
|
"type": "``null`` \\| `Date`",
|
|
"description": "The date with timezone at which the resource was deleted.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The claim image's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "metadata",
|
|
"type": "`Record<string, unknown>`",
|
|
"description": "An optional key-value map with additional details",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "url",
|
|
"type": "`string`",
|
|
"description": "The URL of the image",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "item",
|
|
"type": "[LineItem](LineItem.mdx)",
|
|
"description": "The details of the line item in the original order that this claim item refers to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": [
|
|
{
|
|
"name": "adjustments",
|
|
"type": "[LineItemAdjustment](LineItemAdjustment.mdx)[]",
|
|
"description": "The details of the item's adjustments, which are available when a discount is applied on the item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "allow_discounts",
|
|
"type": "`boolean`",
|
|
"description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
|
|
"optional": false,
|
|
"defaultValue": "true",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "cart",
|
|
"type": "[Cart](Cart.mdx)",
|
|
"description": "The details of the cart that the line item may belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "cart_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the cart that the line item may belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "claim_order",
|
|
"type": "[ClaimOrder](ClaimOrder.mdx)",
|
|
"description": "The details of the claim that the line item may belong to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "claim_order_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the claim that the line item may belong to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "description",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "A more detailed description of the contents of the Line Item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "discount_total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The total of discount of the line item rounded",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "fulfilled_quantity",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The quantity of the Line Item that has been fulfilled.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "gift_card_total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The total of the gift card of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "has_shipping",
|
|
"type": "``null`` \\| `boolean`",
|
|
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The line item's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "includes_tax",
|
|
"type": "`boolean`",
|
|
"description": "Indicates if the line item unit\\_price include tax",
|
|
"optional": false,
|
|
"defaultValue": "false",
|
|
"expandable": false,
|
|
"featureFlag": "tax_inclusive_pricing",
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "is_giftcard",
|
|
"type": "`boolean`",
|
|
"description": "Flag to indicate if the Line Item is a Gift Card.",
|
|
"optional": false,
|
|
"defaultValue": "false",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "is_return",
|
|
"type": "`boolean`",
|
|
"description": "Is the item being returned",
|
|
"optional": false,
|
|
"defaultValue": "false",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "metadata",
|
|
"type": "`Record<string, unknown>`",
|
|
"description": "An optional key-value map with additional details",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order",
|
|
"type": "[Order](Order.mdx)",
|
|
"description": "The details of the order that the line item may belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order_edit",
|
|
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
|
|
"description": "The details of the order edit.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order_edit_id",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The ID of the order edit that the item may belong to.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "order_id",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The ID of the order that the line item may belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_item_id",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_tax_total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The original tax total amount of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "original_total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The original total amount of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "product_id",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "quantity",
|
|
"type": "`number`",
|
|
"description": "The quantity of the content in the Line Item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "raw_discount_total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The total of discount of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "refundable",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "returned_quantity",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The quantity of the Line Item that has been returned.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "shipped_quantity",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The quantity of the Line Item that has been shipped.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "should_merge",
|
|
"type": "`boolean`",
|
|
"description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
|
|
"optional": false,
|
|
"defaultValue": "true",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "subtotal",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The subtotal of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "swap",
|
|
"type": "[Swap](Swap.mdx)",
|
|
"description": "The details of the swap that the line item may belong to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "swap_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the swap that the line item may belong to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "tax_lines",
|
|
"type": "[LineItemTaxLine](LineItemTaxLine.mdx)[]",
|
|
"description": "The details of the item's tax lines.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "tax_total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The total of tax of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "thumbnail",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "A URL string to a small image of the contents of the Line Item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "`string`",
|
|
"description": "The title of the Line Item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "total",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The total amount of the line item",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "unit_price",
|
|
"type": "`number`",
|
|
"description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "variant",
|
|
"type": "[ProductVariant](ProductVariant.mdx)",
|
|
"description": "The details of the product variant that this item was created from.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "variant_id",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The id of the Product Variant contained in the Line Item.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "item_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the line item that the claim item refers to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "metadata",
|
|
"type": "`Record<string, unknown>`",
|
|
"description": "An optional key-value map with additional details",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "note",
|
|
"type": "`string`",
|
|
"description": "An optional note about the claim, for additional information",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "quantity",
|
|
"type": "`number`",
|
|
"description": "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "reason",
|
|
"type": "[ClaimReason](../enums/ClaimReason.mdx)",
|
|
"description": "The reason for the claim",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": [
|
|
{
|
|
"name": "MISSING_ITEM",
|
|
"type": "``\"missing_item\"``",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "OTHER",
|
|
"type": "``\"other\"``",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "PRODUCTION_FAILURE",
|
|
"type": "``\"production_failure\"``",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "WRONG_ITEM",
|
|
"type": "``\"wrong_item\"``",
|
|
"description": "",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "tags",
|
|
"type": "[ClaimTag](ClaimTag.mdx)[]",
|
|
"description": "User defined tags for easy filtering and grouping.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": [
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "deleted_at",
|
|
"type": "``null`` \\| `Date`",
|
|
"description": "The date with timezone at which the resource was deleted.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The claim tag's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "metadata",
|
|
"type": "`Record<string, unknown>`",
|
|
"description": "An optional key-value map with additional details",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "value",
|
|
"type": "`string`",
|
|
"description": "The value that the claim tag holds",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "variant",
|
|
"type": "[ProductVariant](ProductVariant.mdx)",
|
|
"description": "The details of the product variant to potentially replace the item in the original order.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": [
|
|
{
|
|
"name": "allow_backorder",
|
|
"type": "`boolean`",
|
|
"description": "Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.",
|
|
"optional": false,
|
|
"defaultValue": "false",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "barcode",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was created.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "deleted_at",
|
|
"type": "``null`` \\| `Date`",
|
|
"description": "The date with timezone at which the resource was deleted.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "ean",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "An EAN barcode number that can be used to identify the Product Variant.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "height",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "hs_code",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The product variant's ID",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "inventory_items",
|
|
"type": "[ProductVariantInventoryItem](ProductVariantInventoryItem.mdx)[]",
|
|
"description": "The details inventory items of the product variant.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "inventory_quantity",
|
|
"type": "`number`",
|
|
"description": "The current quantity of the item that is stocked.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "length",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "manage_inventory",
|
|
"type": "`boolean`",
|
|
"description": "Whether Medusa should manage inventory for the Product Variant.",
|
|
"optional": false,
|
|
"defaultValue": "true",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "material",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "metadata",
|
|
"type": "``null`` \\| `Record<string, unknown>`",
|
|
"description": "An optional key-value map with additional details",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "mid_code",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "options",
|
|
"type": "[ProductOptionValue](ProductOptionValue.mdx)[]",
|
|
"description": "The details of the product options that this product variant defines values for.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "origin_country",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "prices",
|
|
"type": "[MoneyAmount](MoneyAmount.mdx)[]",
|
|
"description": "The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "product",
|
|
"type": "[Product](Product.mdx)",
|
|
"description": "The details of the product that the product variant belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": true,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "product_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the product that the product variant belongs to.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "purchasable",
|
|
"type": "`boolean`",
|
|
"description": "Only used with the inventory modules. A boolean value indicating whether the Product Variant is purchasable. A variant is purchasable if: - inventory is not managed - it has no inventory items - it is in stock - it is backorderable.",
|
|
"optional": true,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "sku",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "title",
|
|
"type": "`string`",
|
|
"description": "A title that can be displayed for easy identification of the Product Variant.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "upc",
|
|
"type": "``null`` \\| `string`",
|
|
"description": "A UPC barcode number that can be used to identify the Product Variant.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "updated_at",
|
|
"type": "`Date`",
|
|
"description": "The date with timezone at which the resource was updated.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "variant_rank",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The ranking of this variant",
|
|
"optional": false,
|
|
"defaultValue": "0",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "weight",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "width",
|
|
"type": "``null`` \\| `number`",
|
|
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "variant_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the product variant that is claimed.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|