asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: general fixes to references (#5653)

Browse Source 
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-11-17 19:36:58 +02:00
1 parent b3093c3e3d
commit c51dce164d
869 files changed
+15238 -7267
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/docs/content/references/entities/classes/Address.mdx
+14 -14
View File
@@ -13,7 +13,7 @@ An address is used across the Medusa backend within other schemas and object typ
<ParameterTypes parameters={[
{
"name": "address_1",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
@@ -22,7 +22,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "address_2",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "city",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "company",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "country",
"type": "``null`` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "country_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "customer",
"type": "``null`` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "first_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "last_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "phone",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "postal_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ An address is used across the Medusa backend within other schemas and object typ
},
{
"name": "province",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/AnalyticsConfig.mdx
+1 -1
View File
@@ -31,7 +31,7 @@ Base abstract entity for all entities
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/BatchJob.mdx
+11 -11
View File
@@ -58,7 +58,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the batch job.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "result",
"type": "`&#123; advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] &#125;` & `Record<string, unknown>`",
"type": "``{ advancement_count?: number ; count?: number ; errors?: (string \\| [BatchJobResultError](../types/BatchJobResultError.mdx))[] ; file_key?: string ; file_size?: number ; progress?: number ; stat_descriptors?: [BatchJobResultStatDescriptor](../types/BatchJobResultStatDescriptor.mdx)[] }`` & `Record<string, unknown>`",
"description": "The result of the batch job.",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
"children": [
{
"name": "CANCELED",
"type": "``\"canceled\"``",
"type": "`\"canceled\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -320,7 +320,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "COMPLETED",
"type": "``\"completed\"``",
"type": "`\"completed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -329,7 +329,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "CONFIRMED",
"type": "``\"confirmed\"``",
"type": "`\"confirmed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -338,7 +338,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "CREATED",
"type": "``\"created\"``",
"type": "`\"created\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -347,7 +347,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "FAILED",
"type": "``\"failed\"``",
"type": "`\"failed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -356,7 +356,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "PRE_PROCESSED",
"type": "``\"pre_processed\"``",
"type": "`\"pre_processed\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -365,7 +365,7 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat
},
{
"name": "PROCESSING",
"type": "``\"processing\"``",
"type": "`\"processing\"`",
"description": "",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Cart.mdx
+8 -8
View File
@@ -76,7 +76,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -184,7 +184,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -220,7 +220,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -355,7 +355,7 @@ A cart represents a virtual shopping bag. It can be used to complete an order, a
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimImage.mdx
+2 -2
View File
@@ -48,7 +48,7 @@ The details of an image attached to a claim.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ The details of an image attached to a claim.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimItem.mdx
+43 -43
View File
@@ -230,7 +230,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
@@ -419,7 +419,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "fulfilled_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "gift_card_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
@@ -437,7 +437,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "has_shipping",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
@@ -501,7 +501,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order_edit",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -510,7 +510,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order_edit_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
@@ -519,7 +519,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -528,7 +528,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "original_item_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -537,7 +537,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "original_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -546,7 +546,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "original_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -555,7 +555,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "product_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -573,7 +573,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "raw_discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
@@ -582,7 +582,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "refundable",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
@@ -591,7 +591,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "returned_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
@@ -600,7 +600,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "shipped_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
@@ -618,7 +618,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "subtotal",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
@@ -654,7 +654,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
@@ -663,7 +663,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -681,7 +681,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -717,7 +717,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "variant_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
@@ -772,7 +772,7 @@ A claim item is an item created as part of a claim. It references an item in the
"children": [
{
"name": "MISSING_ITEM",
"type": "``\"missing_item\"``",
"type": "`\"missing_item\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -781,7 +781,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "OTHER",
"type": "``\"other\"``",
"type": "`\"other\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -790,7 +790,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "PRODUCTION_FAILURE",
"type": "``\"production_failure\"``",
"type": "`\"production_failure\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -799,7 +799,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "WRONG_ITEM",
"type": "``\"wrong_item\"``",
"type": "`\"wrong_item\"`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -827,7 +827,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -900,7 +900,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -918,7 +918,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -927,7 +927,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -936,7 +936,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -945,7 +945,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -981,7 +981,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -999,7 +999,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -1008,7 +1008,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1017,7 +1017,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -1035,7 +1035,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -1080,7 +1080,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -1098,7 +1098,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -1116,7 +1116,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -1125,7 +1125,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1134,7 +1134,7 @@ A claim item is an item created as part of a claim. It references an item in the
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ClaimTag.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ Claim Tags are user defined tags that can be assigned to claim items for easy fi
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Country.mdx
+4 -4
View File
@@ -120,7 +120,7 @@ Country details
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ Country details
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ Country details
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -249,7 +249,7 @@ Country details
},
{
"name": "region_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The region ID this country is associated with.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/CustomShippingOption.mdx
+11 -11
View File
@@ -84,7 +84,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -192,7 +192,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -228,7 +228,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -363,7 +363,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -419,7 +419,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -472,7 +472,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -499,7 +499,7 @@ Custom Shipping Options are overridden Shipping Options. Admins can attach a Cus
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Customer.mdx
+38 -38
View File
@@ -21,7 +21,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "address_1",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
@@ -30,7 +30,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "address_2",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
@@ -39,7 +39,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "city",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "company",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "first_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "last_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "phone",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "postal_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "province",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -518,7 +518,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -635,7 +635,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -752,7 +752,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -788,7 +788,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -833,7 +833,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -842,7 +842,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -897,7 +897,7 @@ A customer can make purchases in your store and manage their profile.
"children": [
{
"name": "address_1",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 1",
"optional": false,
"defaultValue": "",
@@ -906,7 +906,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "address_2",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Address line 2",
"optional": false,
"defaultValue": "",
@@ -915,7 +915,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "city",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "City",
"optional": false,
"defaultValue": "",
@@ -924,7 +924,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "company",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Company name",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country",
"type": "``null`` \\| [Country](Country.mdx)",
"type": "`null` \\| [Country](Country.mdx)",
"description": "A country object.",
"optional": false,
"defaultValue": "",
@@ -942,7 +942,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "country_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The 2 character ISO code of the country in lower case",
"optional": false,
"defaultValue": "",
@@ -960,7 +960,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer",
"type": "``null`` \\| [Customer](Customer.mdx)",
"type": "`null` \\| [Customer](Customer.mdx)",
"description": "Available if the relation `customer` is expanded.",
"optional": false,
"defaultValue": "",
@@ -969,7 +969,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "ID of the customer this address belongs to",
"optional": false,
"defaultValue": "",
@@ -978,7 +978,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "first_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "First name",
"optional": false,
"defaultValue": "",
@@ -1005,7 +1005,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "last_name",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Last name",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "phone",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Phone Number",
"optional": false,
"defaultValue": "",
@@ -1032,7 +1032,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "postal_code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Postal Code",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1041,7 @@ A customer can make purchases in your store and manage their profile.
},
{
"name": "province",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Province",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/CustomerGroup.mdx
+6 -6
View File
@@ -39,7 +39,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -238,7 +238,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ A customer group that can be used to organize customers into groups of similar t
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Discount.mdx
+12 -12
View File
@@ -31,7 +31,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The time at which the discount can no longer be used.",
"optional": false,
"defaultValue": "",
@@ -237,7 +237,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -246,7 +246,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -483,7 +483,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -584,7 +584,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "usage_limit",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum number of times that a discount can be used.",
"optional": false,
"defaultValue": "",
@@ -593,7 +593,7 @@ A discount can be applied to a cart for promotional purposes.
},
{
"name": "valid_duration",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Duration the discount runs between",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountCondition.mdx
+30 -30
View File
@@ -48,7 +48,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -104,7 +104,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "IN",
"type": "``\"in\"``",
"type": "`\"in\"`",
"description": "The discountable resources are within the specified resources.",
"optional": true,
"defaultValue": "",
@@ -257,7 +257,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "NOT_IN",
"type": "``\"not_in\"``",
"type": "`\"not_in\"`",
"description": "The discountable resources are everything but the specified resources.",
"optional": true,
"defaultValue": "",
@@ -285,7 +285,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -367,7 +367,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -505,7 +505,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -523,7 +523,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -532,7 +532,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -550,7 +550,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -559,7 +559,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -568,7 +568,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -577,7 +577,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -613,7 +613,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -622,7 +622,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -631,7 +631,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -640,7 +640,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -658,7 +658,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -712,7 +712,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -730,7 +730,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -757,7 +757,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -784,7 +784,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -793,7 +793,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -812,7 +812,7 @@ Holds rule conditions for when a discount is applicable
"children": [
{
"name": "CUSTOMER_GROUPS",
"type": "``\"customer_groups\"``",
"type": "`\"customer_groups\"`",
"description": "The discount condition is used for customer groups.",
"optional": true,
"defaultValue": "",
@@ -821,7 +821,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCTS",
"type": "``\"products\"``",
"type": "`\"products\"`",
"description": "The discount condition is used for products.",
"optional": true,
"defaultValue": "",
@@ -830,7 +830,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCT_COLLECTIONS",
"type": "``\"product_collections\"``",
"type": "`\"product_collections\"`",
"description": "The discount condition is used for product collections.",
"optional": true,
"defaultValue": "",
@@ -839,7 +839,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCT_TAGS",
"type": "``\"product_tags\"``",
"type": "`\"product_tags\"`",
"description": "The discount condition is used for product tags.",
"optional": true,
"defaultValue": "",
@@ -848,7 +848,7 @@ Holds rule conditions for when a discount is applicable
},
{
"name": "PRODUCT_TYPES",
"type": "``\"product_types\"``",
"type": "`\"product_types\"`",
"description": "The discount condition is used for product types.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionCustomerGroup.mdx
+2 -2
View File
@@ -57,7 +57,7 @@ Associates a discount condition with a customer group
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ Associates a discount condition with a customer group
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProduct.mdx
+18 -18
View File
@@ -57,7 +57,7 @@ This represents the association between a discount condition and a product
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ This represents the association between a discount condition and a product
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ This represents the association between a discount condition and a product
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ This represents the association between a discount condition and a product
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ This represents the association between a discount condition and a product
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -257,7 +257,7 @@ This represents the association between a discount condition and a product
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -266,7 +266,7 @@ This represents the association between a discount condition and a product
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -275,7 +275,7 @@ This represents the association between a discount condition and a product
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -311,7 +311,7 @@ This represents the association between a discount condition and a product
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ This represents the association between a discount condition and a product
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -329,7 +329,7 @@ This represents the association between a discount condition and a product
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -338,7 +338,7 @@ This represents the association between a discount condition and a product
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -356,7 +356,7 @@ This represents the association between a discount condition and a product
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -410,7 +410,7 @@ This represents the association between a discount condition and a product
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ This represents the association between a discount condition and a product
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ This represents the association between a discount condition and a product
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ This represents the association between a discount condition and a product
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -491,7 +491,7 @@ This represents the association between a discount condition and a product
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductCollection.mdx
+2 -2
View File
@@ -57,7 +57,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ This represents the association between a discount condition and a product colle
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductTag.mdx
+2 -2
View File
@@ -57,7 +57,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ This represents the association between a discount condition and a product tag
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountConditionProductType.mdx
+2 -2
View File
@@ -57,7 +57,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ This represents the association between a discount condition and a product type
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/DiscountRule.mdx
+7 -7
View File
@@ -21,7 +21,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
"children": [
{
"name": "ITEM",
"type": "``\"item\"``",
"type": "`\"item\"`",
"description": "The discount should be applied to applicable items in the cart.",
"optional": true,
"defaultValue": "",
@@ -30,7 +30,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "TOTAL",
"type": "``\"total\"``",
"type": "`\"total\"`",
"description": "The discount should be applied to the checkout total.",
"optional": true,
"defaultValue": "",
@@ -67,7 +67,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -186,7 +186,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
"children": [
{
"name": "FIXED",
"type": "``\"fixed\"``",
"type": "`\"fixed\"`",
"description": "Discounts that reduce the price by a fixed amount.",
"optional": true,
"defaultValue": "",
@@ -239,7 +239,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "FREE_SHIPPING",
"type": "``\"free_shipping\"``",
"type": "`\"free_shipping\"`",
"description": "Discounts that sets the shipping price to `0`.",
"optional": true,
"defaultValue": "",
@@ -248,7 +248,7 @@ A discount rule defines how a Discount is calculated when applied to a Cart.
},
{
"name": "PERCENTAGE",
"type": "``\"percentage\"``",
"type": "`\"percentage\"`",
"description": "Discounts that reduce the price by a percentage reduction.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Fulfillment.mdx
+10 -10
View File
@@ -321,7 +321,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
@@ -518,7 +518,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -599,7 +599,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -635,7 +635,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -752,7 +752,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -788,7 +788,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -833,7 +833,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -842,7 +842,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -997,7 +997,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1178,7 +1178,7 @@ A Fulfillment is created once an admin can prepare the purchased goods. Fulfillm
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/FulfillmentItem.mdx
+22 -22
View File
@@ -93,7 +93,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
@@ -310,7 +310,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "fulfilled_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -319,7 +319,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "gift_card_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
@@ -328,7 +328,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "has_shipping",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order_edit",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -401,7 +401,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order_edit_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "original_item_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -428,7 +428,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "original_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -437,7 +437,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "original_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -446,7 +446,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "product_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "raw_discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
@@ -473,7 +473,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "refundable",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
@@ -482,7 +482,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "returned_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
@@ -491,7 +491,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "shipped_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
@@ -509,7 +509,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "subtotal",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
@@ -545,7 +545,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
@@ -554,7 +554,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -572,7 +572,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -608,7 +608,7 @@ This represents the association between a Line Item and a Fulfillment.
},
{
"name": "variant_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/GiftCard.mdx
+12 -12
View File
@@ -40,7 +40,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -255,7 +255,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -372,7 +372,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -489,7 +489,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -525,7 +525,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -570,7 +570,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -579,7 +579,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -670,7 +670,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -761,7 +761,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -779,7 +779,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -808,7 +808,7 @@ Gift Cards are redeemable and represent a value that can be used towards the pay
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/GiftCardTransaction.mdx
+10 -10
View File
@@ -66,7 +66,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The gift card's tax rate that will be applied on calculating totals",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -454,7 +454,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -490,7 +490,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -607,7 +607,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -643,7 +643,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -688,7 +688,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -697,7 +697,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -735,7 +735,7 @@ Gift Card Transactions are created once a Customer uses a Gift Card to pay for t
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax rate of the transaction",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Image.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ An Image is used to store details about uploaded images. Images are uploaded by
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Invite.mdx
+4 -4
View File
@@ -31,7 +31,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ An invite is created when an admin user invites a new user to join the store's t
"children": [
{
"name": "ADMIN",
"type": "``\"admin\"``",
"type": "`\"admin\"`",
"description": "The user is an admin.",
"optional": true,
"defaultValue": "",
@@ -84,7 +84,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "DEVELOPER",
"type": "``\"developer\"``",
"type": "`\"developer\"`",
"description": "The user is a developer.",
"optional": true,
"defaultValue": "",
@@ -93,7 +93,7 @@ An invite is created when an admin user invites a new user to join the store's t
},
{
"name": "MEMBER",
"type": "``\"member\"``",
"type": "`\"member\"`",
"description": "The user is a team member.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/LineItem.mdx
+21 -21
View File
@@ -76,7 +76,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
@@ -94,7 +94,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "fulfilled_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "gift_card_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
@@ -112,7 +112,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "has_shipping",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -185,7 +185,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_edit_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
@@ -194,7 +194,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_item_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -212,7 +212,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -221,7 +221,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "original_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -230,7 +230,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "product_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "raw_discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
@@ -257,7 +257,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "refundable",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
@@ -266,7 +266,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "returned_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
@@ -275,7 +275,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "shipped_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "subtotal",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
@@ -329,7 +329,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
@@ -338,7 +338,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -356,7 +356,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -392,7 +392,7 @@ Line Items are created when a product is added to a Cart. When Line Items are pu
},
{
"name": "variant_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/LineItemTaxLine.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ A Line Item Tax Line represents the taxes applied on a line item.
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/MoneyAmount.mdx
+38 -38
View File
@@ -96,7 +96,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -114,7 +114,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"optional": false,
"defaultValue": "",
@@ -132,7 +132,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "price_list",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "price_list_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -294,7 +294,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -312,7 +312,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -367,7 +367,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -385,7 +385,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -394,7 +394,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -403,7 +403,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -412,7 +412,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -448,7 +448,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -466,7 +466,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -475,7 +475,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -484,7 +484,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -502,7 +502,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -547,7 +547,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -565,7 +565,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -583,7 +583,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -592,7 +592,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -601,7 +601,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -638,7 +638,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -656,7 +656,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -665,7 +665,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -674,7 +674,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -683,7 +683,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -719,7 +719,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -737,7 +737,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -746,7 +746,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -755,7 +755,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -773,7 +773,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -818,7 +818,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -836,7 +836,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -854,7 +854,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -863,7 +863,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -872,7 +872,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Note.mdx
+2 -2
View File
@@ -39,7 +39,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -140,7 +140,7 @@ A Note is an element that can be used in association with different resources to
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Notification.mdx
+5 -5
View File
@@ -39,7 +39,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "billing_address_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The customer's billing address ID",
"optional": false,
"defaultValue": "",
@@ -57,7 +57,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -247,7 +247,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ A notification is an alert sent, typically to customers, using the installed Not
},
{
"name": "customer_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the customer that this notification was sent to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Order.mdx
+7 -7
View File
@@ -175,7 +175,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -256,7 +256,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -409,7 +409,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -445,7 +445,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -490,7 +490,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -499,7 +499,7 @@ An order is a purchase made by a customer. It holds details about payment and fu
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/OrderEdit.mdx
+1 -1
View File
@@ -247,7 +247,7 @@ Order edit allows modifying items in an order, such as adding, updating, or dele
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/OrderItemChange.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ An order item change is a change made within an order edit to an order's items.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Payment.mdx
+16 -16
View File
@@ -120,7 +120,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -228,7 +228,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -264,7 +264,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -372,7 +372,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -399,7 +399,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -726,7 +726,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -807,7 +807,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -843,7 +843,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -960,7 +960,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -996,7 +996,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1041,7 +1041,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1050,7 +1050,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1168,7 +1168,7 @@ A payment is originally created from a payment session. Once a payment session i
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PaymentCollection.mdx
+13 -13
View File
@@ -22,7 +22,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "authorized_amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "Authorized amount of the payment collection.",
"optional": false,
"defaultValue": "",
@@ -114,7 +114,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Description of the payment collection",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "cart_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "is_selected",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.",
"optional": false,
"defaultValue": "",
@@ -511,7 +511,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -602,7 +602,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -620,7 +620,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -657,7 +657,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
"children": [
{
"name": "AUTHORIZED",
"type": "``\"authorized\"``",
"type": "`\"authorized\"`",
"description": "The payment colleciton is authorized.",
"optional": true,
"defaultValue": "",
@@ -666,7 +666,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "AWAITING",
"type": "``\"awaiting\"``",
"type": "`\"awaiting\"`",
"description": "The payment collection is awaiting payment.",
"optional": true,
"defaultValue": "",
@@ -675,7 +675,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "CANCELED",
"type": "``\"canceled\"``",
"type": "`\"canceled\"`",
"description": "The payment collection is canceled.",
"optional": true,
"defaultValue": "",
@@ -684,7 +684,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "NOT_PAID",
"type": "``\"not_paid\"``",
"type": "`\"not_paid\"`",
"description": "The payment collection isn't paid.",
"optional": true,
"defaultValue": "",
@@ -693,7 +693,7 @@ A payment collection allows grouping and managing a list of payments at one. Thi
},
{
"name": "PARTIALLY_AUTHORIZED",
"type": "``\"partially_authorized\"``",
"type": "`\"partially_authorized\"`",
"description": "Some of the payments in the payment collection are authorized.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PaymentSession.mdx
+10 -10
View File
@@ -93,7 +93,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -174,7 +174,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -201,7 +201,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -237,7 +237,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -345,7 +345,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -372,7 +372,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -410,7 +410,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "cart_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the cart that the payment session was created for.",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ A Payment Session is created when a Customer initilizes the checkout flow, and c
},
{
"name": "is_selected",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PriceList.mdx
+17 -17
View File
@@ -48,7 +48,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -104,7 +104,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -122,7 +122,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "ends_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List stops being valid.",
"optional": false,
"defaultValue": "",
@@ -203,7 +203,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "price_list",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -248,7 +248,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "price_list_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -313,7 +313,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "starts_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone that the Price List starts being valid.",
"optional": false,
"defaultValue": "",
@@ -330,8 +330,8 @@ A Price List represents a set of prices that override the default price for one
"children": [
{
"name": "ACTIVE",
"type": "``\"active\"``",
"description": "The price list is active, meaning its prices are applied to customers.",
"type": "`\"active\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -339,8 +339,8 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "DRAFT",
"type": "``\"draft\"``",
"description": "The price list is a draft, meaning its not yet applied to customers.",
"type": "`\"draft\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -358,8 +358,8 @@ A Price List represents a set of prices that override the default price for one
"children": [
{
"name": "OVERRIDE",
"type": "``\"override\"``",
"description": "The price list is used to override original prices for specific conditions.",
"type": "`\"override\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
@@ -367,8 +367,8 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "SALE",
"type": "``\"sale\"``",
"description": "The price list is used for a sale.",
"type": "`\"sale\"`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
www/apps/docs/content/references/entities/classes/Product.mdx
+48 -48
View File
@@ -94,7 +94,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -176,7 +176,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -241,7 +241,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -259,7 +259,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -268,7 +268,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -286,7 +286,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -295,7 +295,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -304,7 +304,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -313,7 +313,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -348,7 +348,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -404,7 +404,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -413,7 +413,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -422,7 +422,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -457,7 +457,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -531,7 +531,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -557,7 +557,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -657,7 +657,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -748,7 +748,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -757,7 +757,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -793,7 +793,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -830,7 +830,7 @@ A product is a saleable item that holds general information such as name or desc
"children": [
{
"name": "DRAFT",
"type": "``\"draft\"``",
"type": "`\"draft\"`",
"description": "The product is a draft. It's not viewable by customers.",
"optional": true,
"defaultValue": "",
@@ -839,7 +839,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "PROPOSED",
"type": "``\"proposed\"``",
"type": "`\"proposed\"`",
"description": "The product is proposed, but not yet published.",
"optional": true,
"defaultValue": "",
@@ -848,7 +848,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "PUBLISHED",
"type": "``\"published\"``",
"type": "`\"published\"`",
"description": "The product is published.",
"optional": true,
"defaultValue": "",
@@ -857,7 +857,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "REJECTED",
"type": "``\"rejected\"``",
"type": "`\"rejected\"`",
"description": "The product is rejected. It's not viewable by customers.",
"optional": true,
"defaultValue": "",
@@ -868,7 +868,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -894,7 +894,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -941,7 +941,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -976,7 +976,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1023,7 +1023,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -1058,7 +1058,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -1076,7 +1076,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1085,7 +1085,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -1094,7 +1094,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1103,7 +1103,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -1139,7 +1139,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1157,7 +1157,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -1166,7 +1166,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1175,7 +1175,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -1193,7 +1193,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -1238,7 +1238,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -1256,7 +1256,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -1274,7 +1274,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -1283,7 +1283,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1292,7 +1292,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1303,7 +1303,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -1312,7 +1312,7 @@ A product is a saleable item that holds general information such as name or desc
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductCategory.mdx
+21 -21
View File
@@ -93,7 +93,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -221,7 +221,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category",
"type": "``null`` \\| [ProductCategory](ProductCategory.mdx)",
"type": "`null` \\| [ProductCategory](ProductCategory.mdx)",
"description": "The details of the parent of this category.",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "parent_category_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent category.",
"optional": false,
"defaultValue": "null",
@@ -266,7 +266,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -284,7 +284,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -293,7 +293,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -311,7 +311,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -329,7 +329,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -338,7 +338,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -374,7 +374,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -392,7 +392,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -419,7 +419,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -473,7 +473,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -491,7 +491,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -518,7 +518,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -545,7 +545,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -554,7 +554,7 @@ A product category can be used to categorize products into a hierarchy of catego
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductCollection.mdx
+18 -18
View File
@@ -22,7 +22,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -193,7 +193,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -211,7 +211,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -238,7 +238,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -292,7 +292,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ A Product Collection allows grouping together products for promotional purposes.
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductOption.mdx
+19 -19
View File
@@ -22,7 +22,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -94,7 +94,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -184,7 +184,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -202,7 +202,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -229,7 +229,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -283,7 +283,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -328,7 +328,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -355,7 +355,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A Product Option defines properties that may vary between different variants of
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductOptionValue.mdx
+17 -17
View File
@@ -22,7 +22,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -184,7 +184,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -211,7 +211,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -229,7 +229,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -265,7 +265,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -292,7 +292,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -301,7 +301,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -319,7 +319,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -364,7 +364,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -382,7 +382,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -400,7 +400,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -409,7 +409,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -418,7 +418,7 @@ An option value is one of the possible values of a Product Option. Product Varia
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTag.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ A Product Tag can be added to Products for easy filtering and grouping.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTaxRate.mdx
+19 -19
View File
@@ -58,7 +58,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -166,7 +166,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -175,7 +175,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -184,7 +184,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -211,7 +211,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -265,7 +265,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -283,7 +283,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -346,7 +346,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -383,7 +383,7 @@ This represents the association between a tax rate and a product to indicate tha
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -464,7 +464,7 @@ This represents the association between a tax rate and a product to indicate tha
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductType.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ A Product Type can be added to Products for filtering and reporting purposes.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductTypeTaxRate.mdx
+3 -3
View File
@@ -48,7 +48,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -121,7 +121,7 @@ This represents the association between a tax rate and a product type to indicat
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ This represents the association between a tax rate and a product type to indicat
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariant.mdx
+39 -39
View File
@@ -22,7 +22,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -40,7 +40,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -58,7 +58,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -102,7 +102,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -176,7 +176,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -203,7 +203,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -238,7 +238,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -321,7 +321,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -374,7 +374,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"optional": false,
"defaultValue": "",
@@ -410,7 +410,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "price_list",
"type": "``null`` \\| [PriceList](PriceList.mdx)",
"type": "`null` \\| [PriceList](PriceList.mdx)",
"description": "The details of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "price_list_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the price list that the money amount may belong to.",
"optional": false,
"defaultValue": "",
@@ -511,7 +511,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -529,7 +529,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -538,7 +538,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -556,7 +556,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -565,7 +565,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -574,7 +574,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -583,7 +583,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -619,7 +619,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -628,7 +628,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -637,7 +637,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -646,7 +646,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -664,7 +664,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -718,7 +718,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -736,7 +736,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -763,7 +763,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -790,7 +790,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -799,7 +799,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -828,7 +828,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -846,7 +846,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -864,7 +864,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -873,7 +873,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -882,7 +882,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariantInventoryItem.mdx
+16 -16
View File
@@ -22,7 +22,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "barcode",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "ean",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -129,7 +129,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -165,7 +165,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -183,7 +183,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -192,7 +192,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -201,7 +201,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -219,7 +219,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -264,7 +264,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "sku",
"type": "``null`` \\| `string`",
"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": "",
@@ -282,7 +282,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "upc",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "variant_rank",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The ranking of this variant",
"optional": false,
"defaultValue": "0",
@@ -309,7 +309,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,7 @@ A Product Variant Inventory Item links variants with inventory items and denotes
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ProductVariantMoneyAmount.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ Base abstract entity for all entities
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/PublishableApiKey.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ A Publishable API key defines scopes that resources are available in. Then, it c
},
{
"name": "created_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that created the key.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ A Publishable API key defines scopes that resources are available in. Then, it c
},
{
"name": "revoked_by",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The unique identifier of the user that revoked the key.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Refund.mdx
+7 -7
View File
@@ -237,7 +237,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -318,7 +318,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -354,7 +354,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -471,7 +471,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -507,7 +507,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -552,7 +552,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -561,7 +561,7 @@ A refund represents an amount of money transfered back to the customer for a giv
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Region.mdx
+4 -4
View File
@@ -93,7 +93,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "region_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The region ID this country is associated with.",
"optional": false,
"defaultValue": "",
@@ -178,7 +178,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -326,7 +326,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -344,7 +344,7 @@ A region holds settings specific to a geographical location, including the curre
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Return.mdx
+20 -20
View File
@@ -212,7 +212,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -366,7 +366,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -375,7 +375,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -384,7 +384,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -563,7 +563,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -644,7 +644,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -680,7 +680,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -797,7 +797,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -833,7 +833,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -878,7 +878,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -887,7 +887,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -916,7 +916,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -987,7 +987,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -1151,7 +1151,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
"children": [
{
"name": "CANCELED",
"type": "``\"canceled\"``",
"type": "`\"canceled\"`",
"description": "The return is canceled.",
"optional": true,
"defaultValue": "",
@@ -1160,7 +1160,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "RECEIVED",
"type": "``\"received\"``",
"type": "`\"received\"`",
"description": "The return is received.",
"optional": true,
"defaultValue": "",
@@ -1169,7 +1169,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "REQUESTED",
"type": "``\"requested\"``",
"type": "`\"requested\"`",
"description": "The return is requested.",
"optional": true,
"defaultValue": "",
@@ -1178,7 +1178,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "REQUIRES_ACTION",
"type": "``\"requires_action\"``",
"type": "`\"requires_action\"`",
"description": "The return is awaiting action.",
"optional": true,
"defaultValue": "",
@@ -1260,7 +1260,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1415,7 +1415,7 @@ A Return holds information about Line Items that a Customer wishes to send back,
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ReturnItem.mdx
+31 -31
View File
@@ -93,7 +93,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A more detailed description of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item rounded",
"optional": true,
"defaultValue": "",
@@ -111,7 +111,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "fulfilled_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been fulfilled.",
"optional": false,
"defaultValue": "",
@@ -120,7 +120,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "gift_card_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of the gift card of the line item",
"optional": true,
"defaultValue": "",
@@ -129,7 +129,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "has_shipping",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"optional": false,
"defaultValue": "",
@@ -193,7 +193,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order_edit",
"type": "``null`` \\| [OrderEdit](OrderEdit.mdx)",
"type": "`null` \\| [OrderEdit](OrderEdit.mdx)",
"description": "The details of the order edit.",
"optional": true,
"defaultValue": "",
@@ -202,7 +202,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order_edit_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order edit that the item may belong to.",
"optional": true,
"defaultValue": "",
@@ -211,7 +211,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the line item may belongs to.",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "original_item_id",
"type": "``null`` \\| `string`",
"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": "",
@@ -229,7 +229,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "original_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original tax total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -238,7 +238,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "original_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The original total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -247,7 +247,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "product_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -265,7 +265,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "raw_discount_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of discount of the line item",
"optional": true,
"defaultValue": "",
@@ -274,7 +274,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "refundable",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"optional": true,
"defaultValue": "",
@@ -283,7 +283,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "returned_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been returned.",
"optional": false,
"defaultValue": "",
@@ -292,7 +292,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "shipped_quantity",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The quantity of the Line Item that has been shipped.",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "subtotal",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The subtotal of the line item",
"optional": true,
"defaultValue": "",
@@ -346,7 +346,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax of the line item",
"optional": true,
"defaultValue": "",
@@ -355,7 +355,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL string to a small image of the contents of the Line Item.",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total amount of the line item",
"optional": true,
"defaultValue": "",
@@ -409,7 +409,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "variant_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The id of the Product Variant contained in the Line Item.",
"optional": false,
"defaultValue": "",
@@ -473,7 +473,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -518,7 +518,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -527,7 +527,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -618,7 +618,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -645,7 +645,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -663,7 +663,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -672,7 +672,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -681,7 +681,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -699,7 +699,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -762,7 +762,7 @@ A return item represents a line item in an order that is to be returned. It incl
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ReturnReason.mdx
+6 -6
View File
@@ -22,7 +22,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -67,7 +67,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -76,7 +76,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -147,7 +147,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason",
"type": "``null`` \\| [ReturnReason](ReturnReason.mdx)",
"type": "`null` \\| [ReturnReason](ReturnReason.mdx)",
"description": "The details of the parent reason.",
"optional": false,
"defaultValue": "",
@@ -156,7 +156,7 @@ A Return Reason is a value defined by an admin. It can be used on Return Items i
},
{
"name": "parent_return_reason_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the parent reason.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/SalesChannel.mdx
+4 -4
View File
@@ -22,7 +22,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -31,7 +31,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -131,7 +131,7 @@ A Sales Channel is a method a business offers its products for purchase for the
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/SalesChannelLocation.mdx
+4 -4
View File
@@ -22,7 +22,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -66,7 +66,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -75,7 +75,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ This represents the association between a sales channel and a stock locations.
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingMethod.mdx
+27 -27
View File
@@ -84,7 +84,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -165,7 +165,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of items with taxes",
"optional": true,
"defaultValue": "",
@@ -192,7 +192,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "object",
"type": "``\"cart\"``",
"type": "`\"cart\"`",
"description": "",
"optional": false,
"defaultValue": "\"cart\"",
@@ -228,7 +228,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "payment_session",
"type": "``null`` \\| [PaymentSession](PaymentSession.mdx)",
"type": "`null` \\| [PaymentSession](PaymentSession.mdx)",
"description": "The details of the selected payment session in the cart.",
"optional": false,
"defaultValue": "",
@@ -300,7 +300,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The sales channel ID the cart is associated with.",
"optional": false,
"defaultValue": "",
@@ -309,7 +309,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_address",
"type": "``null`` \\| [Address](Address.mdx)",
"type": "`null` \\| [Address](Address.mdx)",
"description": "The details of the shipping address associated with the cart.",
"optional": false,
"defaultValue": "",
@@ -336,7 +336,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of shipping with taxes",
"optional": true,
"defaultValue": "",
@@ -363,7 +363,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": true,
"defaultValue": "",
@@ -609,7 +609,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
@@ -816,7 +816,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of an external order.",
"optional": false,
"defaultValue": "",
@@ -897,7 +897,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "item_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on items",
"optional": false,
"defaultValue": "",
@@ -933,7 +933,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "object",
"type": "``\"order\"``",
"type": "`\"order\"`",
"description": "",
"optional": false,
"defaultValue": "\"order\"",
@@ -1050,7 +1050,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the sales channel this order belongs to.",
"optional": false,
"defaultValue": "",
@@ -1086,7 +1086,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "shipping_tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The tax total applied on shipping",
"optional": false,
"defaultValue": "",
@@ -1131,7 +1131,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The order's tax rate",
"optional": false,
"defaultValue": "",
@@ -1140,7 +1140,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_total",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The total of tax",
"optional": false,
"defaultValue": "",
@@ -1213,7 +1213,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1240,7 +1240,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "idempotency_key",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"optional": false,
"defaultValue": "",
@@ -1258,7 +1258,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the return will be added back.",
"optional": false,
"defaultValue": "",
@@ -1267,7 +1267,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -1276,7 +1276,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "no_notification",
"type": "``null`` \\| `boolean`",
"type": "`null` \\| `boolean`",
"description": "When set to true, no notification will be sent related to this return.",
"optional": false,
"defaultValue": "",
@@ -1294,7 +1294,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the order that the return was created for.",
"optional": false,
"defaultValue": "",
@@ -1357,7 +1357,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "swap_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the swap that the return may belong to.",
"optional": false,
"defaultValue": "",
@@ -1394,7 +1394,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -1421,7 +1421,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1648,7 +1648,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -1820,7 +1820,7 @@ A Shipping Method represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingMethodTaxLine.mdx
+2 -2
View File
@@ -13,7 +13,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A Shipping Method Tax Line represents the taxes applied on a shipping method in
},
{
"name": "claim_order_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the claim that the shipping method is used in.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingOption.mdx
+8 -8
View File
@@ -22,7 +22,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -49,7 +49,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
"children": [
{
"name": "CALCULATED",
"type": "``\"calculated\"``",
"type": "`\"calculated\"`",
"description": "The shipping option's price is calculated. In this case, the `amount` field is typically `null`.",
"optional": true,
"defaultValue": "",
@@ -121,7 +121,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "FLAT_RATE",
"type": "``\"flat_rate\"``",
"type": "`\"flat_rate\"`",
"description": "The shipping option's price is a flat rate.",
"optional": true,
"defaultValue": "",
@@ -149,7 +149,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -322,7 +322,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -413,7 +413,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -431,7 +431,7 @@ A Shipping Option represents a way in which an Order or Return can be shipped. S
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingOptionRequirement.mdx
+4 -4
View File
@@ -57,7 +57,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
"children": [
{
"name": "MAX_SUBTOTAL",
"type": "``\"max_subtotal\"``",
"type": "`\"max_subtotal\"`",
"description": "The shipping option can only be applied if the subtotal is less than the requirement's amont.",
"optional": true,
"defaultValue": "",
@@ -248,7 +248,7 @@ A shipping option requirement defines conditions that a Cart must satisfy for th
},
{
"name": "MIN_SUBTOTAL",
"type": "``\"min_subtotal\"``",
"type": "`\"min_subtotal\"`",
"description": "The shipping option can only be applied if the subtotal is greater than the requirement's amount.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingProfile.mdx
+23 -23
View File
@@ -22,7 +22,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -85,7 +85,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -103,7 +103,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -112,7 +112,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -130,7 +130,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -139,7 +139,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -148,7 +148,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -157,7 +157,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -193,7 +193,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -202,7 +202,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -211,7 +211,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -220,7 +220,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -238,7 +238,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -292,7 +292,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -310,7 +310,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -337,7 +337,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -364,7 +364,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -373,7 +373,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -401,7 +401,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -428,7 +428,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -574,7 +574,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
"children": [
{
"name": "CUSTOM",
"type": "``\"custom\"``",
"type": "`\"custom\"`",
"description": "The profile used to ship custom items.",
"optional": true,
"defaultValue": "",
@@ -583,7 +583,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "DEFAULT",
"type": "``\"default\"``",
"type": "`\"default\"`",
"description": "The default profile used to ship item.",
"optional": true,
"defaultValue": "",
@@ -592,7 +592,7 @@ A Shipping Profile has a set of defined Shipping Options that can be used to ful
},
{
"name": "GIFT_CARD",
"type": "``\"gift_card\"``",
"type": "`\"gift_card\"`",
"description": "The profile used to ship gift cards.",
"optional": true,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/ShippingTaxRate.mdx
+4 -4
View File
@@ -57,7 +57,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -84,7 +84,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ This represents the tax rates applied on a shipping option.
"children": [
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -320,7 +320,7 @@ This represents the tax rates applied on a shipping option.
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/SoftDeletableEntity.mdx
+1 -1
View File
@@ -22,7 +22,7 @@ Base abstract entity for all entities
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Store.mdx
+8 -8
View File
@@ -169,7 +169,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -178,7 +178,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The description of the sales channel.",
"optional": false,
"defaultValue": "",
@@ -214,7 +214,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -243,7 +243,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "default_sales_channel_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the store's default sales channel.",
"optional": false,
"defaultValue": "",
@@ -261,7 +261,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "invite_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Invite links from",
"optional": false,
"defaultValue": "",
@@ -270,7 +270,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -288,7 +288,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "payment_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Payment links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the payment's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
@@ -297,7 +297,7 @@ A store holds the main settings of the commerce shop. By default, only one store
},
{
"name": "swap_link_template",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A template to generate Swap links from. Use &#123;&#123;cart\\_id&#125;&#125; to include the Swap's `cart\\_id` in the link.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/Swap.mdx
+1 -1
View File
@@ -76,7 +76,7 @@ A swap can be created when a Customer wishes to exchange Products that they have
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/TaxLine.mdx
+1 -1
View File
@@ -13,7 +13,7 @@ A tax line represents the taxes amount applied to a line item.
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/TaxRate.mdx
+25 -25
View File
@@ -13,7 +13,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
<ParameterTypes parameters={[
{
"name": "code",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A code to identify the tax type by",
"optional": false,
"defaultValue": "",
@@ -93,7 +93,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -167,7 +167,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "collection_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product collection that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -185,7 +185,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -194,7 +194,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "description",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A short description of the Product.",
"optional": false,
"defaultValue": "",
@@ -212,7 +212,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "external_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The external ID of the product",
"optional": false,
"defaultValue": "",
@@ -221,7 +221,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "handle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A unique identifier for the Product (e.g. for slug structure).",
"optional": false,
"defaultValue": "",
@@ -230,7 +230,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "height",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -239,7 +239,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "hs_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -275,7 +275,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "length",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -284,7 +284,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "material",
"type": "``null`` \\| `string`",
"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": "",
@@ -293,7 +293,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "metadata",
"type": "``null`` \\| `Record<string, unknown>`",
"type": "`null` \\| `Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -302,7 +302,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "mid_code",
"type": "``null`` \\| `string`",
"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": "",
@@ -320,7 +320,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "origin_country",
"type": "``null`` \\| `string`",
"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": "",
@@ -374,7 +374,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "subtitle",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "An optional subtitle that can be used to further specify the Product.",
"optional": false,
"defaultValue": "",
@@ -392,7 +392,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "thumbnail",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "A URL to an image file that can be used to identify the Product.",
"optional": false,
"defaultValue": "",
@@ -419,7 +419,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "type_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the product type that the product belongs to.",
"optional": false,
"defaultValue": "",
@@ -446,7 +446,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "weight",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -455,7 +455,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "width",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"optional": false,
"defaultValue": "",
@@ -466,7 +466,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "rate",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The numeric rate to charge",
"optional": false,
"defaultValue": "",
@@ -528,7 +528,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -619,7 +619,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_provider_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the tax provider used in this region",
"optional": false,
"defaultValue": "",
@@ -637,7 +637,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "tax_rates",
"type": "``null`` \\| [TaxRate](TaxRate.mdx)[]",
"type": "`null` \\| [TaxRate](TaxRate.mdx)[]",
"description": "The details of the tax rates used in the region, aside from the default rate.",
"optional": false,
"defaultValue": "",
@@ -692,7 +692,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "amount",
"type": "``null`` \\| `number`",
"type": "`null` \\| `number`",
"description": "The amount to charge for shipping when the Shipping Option price type is `flat\\_rate`.",
"optional": false,
"defaultValue": "",
@@ -719,7 +719,7 @@ A Tax Rate can be used to define a custom rate to charge on specified products,
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/TrackingLink.mdx
+2 -2
View File
@@ -22,7 +22,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -111,7 +111,7 @@ A tracking link holds information about tracking numbers for a Fulfillment. Trac
},
{
"name": "location_id",
"type": "``null`` \\| `string`",
"type": "`null` \\| `string`",
"description": "The ID of the stock location the fulfillment will be shipped from",
"optional": false,
"defaultValue": "",
www/apps/docs/content/references/entities/classes/User.mdx
+4 -4
View File
@@ -31,7 +31,7 @@ A User is an administrator who can manage store settings and data.
},
{
"name": "deleted_at",
"type": "``null`` \\| `Date`",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
@@ -102,7 +102,7 @@ A User is an administrator who can manage store settings and data.
"children": [
{
"name": "ADMIN",
"type": "``\"admin\"``",
"type": "`\"admin\"`",
"description": "The user is an admin.",
"optional": true,
"defaultValue": "",
@@ -111,7 +111,7 @@ A User is an administrator who can manage store settings and data.
},
{
"name": "DEVELOPER",
"type": "``\"developer\"``",
"type": "`\"developer\"`",
"description": "The user is a developer.",
"optional": true,
"defaultValue": "",
@@ -120,7 +120,7 @@ A User is an administrator who can manage store settings and data.
},
{
"name": "MEMBER",
"type": "``\"member\"``",
"type": "`\"member\"`",
"description": "The user is a team member.",
"optional": true,
"defaultValue": "",