chore(docs): Generated References (automated) (#10276)

Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-11-26 09:24:41 +00:00
1 parent 67e2e718e9
commit d5ee0070b4
928 files changed
+182409 -172163

No files matched your search

@@ -61,7 +61,7 @@ const [fulfillmentSets, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
## Returns
@@ -61,7 +61,7 @@ const [fulfillments, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the fulfillments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their packing date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their shipping date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their delivery date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their cancelation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated fulfillment provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"Filter the fulfillments by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined Line truncated
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the fulfillments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their packing date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their shipping date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their delivery date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their cancelation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated fulfillment provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"Filter the fulfillments by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined Line truncated
## Returns
@@ -61,7 +61,7 @@ const [geoZones, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the retrieved geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx) \\| [GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx)[]","description":"Filter the geo zones by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `string`[]","description":"Filter the geo zones by their city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../Line truncated
<TypeList types={[{"name":"filters","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the retrieved geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx) \\| [GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx)[]","description":"Filter the geo zones by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `string`[]","description":"Filter the geo zones by their city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../Line truncated
## Returns
@@ -61,7 +61,7 @@ const [serviceZones, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idLine truncated
## Returns
@@ -63,7 +63,7 @@ const [shippingOptionRules, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their operator.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableSLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their operator.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableSLine truncated
## Returns
@@ -63,7 +63,7 @@ const [shippingOptionTypes, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippiLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippiLine truncated
## Returns
@@ -61,7 +61,7 @@ const [shippingOptions, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"Omit&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx), \"context\"&#62;","description":"Construct a type with the properties of T except for those in type K.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;ShippingOptionPriceType | ShippingOptionPriceType[]&#62;","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","dLine truncated
<TypeList types={[{"name":"filters","type":"Omit&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx), \"context\"&#62;","description":"Construct a type with the properties of T except for those in type K.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;ShippingOptionPriceType | ShippingOptionPriceType[]&#62;","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","dLine truncated
## Returns
@@ -63,7 +63,7 @@ const [shippingProfiles, count] =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where eachLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where eachLine truncated
## Returns
@@ -30,7 +30,7 @@ const providers = await fulfillmentModuleService.listFulfillmentProviders({
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment providers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the provider by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the provider by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BasLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment providers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the provider by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProviderProps](../../../interfaces/fulfillment.FilterableFulfillmentProviderProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the provider by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BasLine truncated
## Returns
@@ -58,7 +58,7 @@ const fulfillmentSets = await fulfillmentModuleService.listFulfillmentSets(
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the retrieved fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[]","description":"Filter the fulfillment sets by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zones","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the fulfillment sets by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \Line truncated
## Returns
@@ -61,7 +61,7 @@ const fulfillments =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)","description":"The filters to apply on the retrieved fulfillments.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the fulfillments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their packing date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their shipping date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their delivery date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their cancelation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated fulfillment provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"Filter the fulfillments by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined withLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)","description":"The filters to apply on the retrieved fulfillments.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableFulfillmentProps](../../../interfaces/fulfillment.FilterableFulfillmentProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the fulfillments by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their packing date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their shipping date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their delivery date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their cancelation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by the ID of their associated fulfillment provider.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"Filter the fulfillments by the ID of their associated shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date` \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the fulfillments by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined withLine truncated
## Returns
@@ -58,7 +58,7 @@ const geoZones = await fulfillmentModuleService.listGeoZones(
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the retrieved geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx) \\| [GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx)[]","description":"Filter the geo zones by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `string`[]","description":"Filter the geo zones by their city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../Line truncated
<TypeList types={[{"name":"filters","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the retrieved geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx) \\| [GeoZoneType](../../../types/fulfillment.GeoZoneType/page.mdx)[]","description":"Filter the geo zones by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their country code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province_code","type":"`string` \\| `string`[]","description":"Filter the geo zones by their province code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string` \\| `string`[]","description":"Filter the geo zones by their city.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the geo zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[GeoZoneType](../Line truncated
## Returns
@@ -61,7 +61,7 @@ const serviceZones =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the service zones by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the service zones by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"geo_zones","type":"[FilterableGeoZoneProps](../../../interfaces/fulfillment.FilterableGeoZoneProps/page.mdx)","description":"The filters to apply on the associated geo zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_set","type":"[FilterableFulfillmentSetProps](../../../interfaces/fulfillment.FilterableFulfillmentSetProps/page.mdx)","description":"The filters to apply on the associated fulfillment sets.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idLine truncated
## Returns
@@ -61,7 +61,7 @@ const shippingOptionRules =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their operator.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableSLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option rules by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their attribute.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their operator.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option rules by their values.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableSLine truncated
## Returns
@@ -61,7 +61,7 @@ const shippingOptionTypes =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippiLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping option types by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"label","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their label.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping option types by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippiLine truncated
## Returns
@@ -61,7 +61,7 @@ const shippingOptions =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;ShippingOptionPriceType | ShippingOptionPriceType[]&#62;","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An arrayLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;ShippingOptionPriceType | ShippingOptionPriceType[]&#62;","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An arrayLine truncated
## Returns
@@ -72,7 +72,7 @@ const shippingOptions =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The context of the how the shipping option is being used. It\nacts as a filter for the retrieved shipping options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;ShippingOptionPriceType | ShippingOptionPriceType[]&#62;","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingOptionForContextProps](../../../interfaces/fulfillment.FilterableShippingOptionForContextProps/page.mdx)","description":"The context of the how the shipping option is being used. It\nacts as a filter for the retrieved shipping options.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping options by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_profile_id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping options by the ID of their associated shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"price_type","type":"[ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx) \\| [ShippingOptionPriceType](../../../types/fulfillment.ShippingOptionPriceType/page.mdx)[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;ShippingOptionPriceType | ShippingOptionPriceType[]&#62;","description":"Filter the shipping options by their price type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"service_zone","type":"[FilterableServiceZoneProps](../../../interfaces/fulfillment.FilterableServiceZoneProps/page.mdx)","description":"The filters to apply on the retrieved service zones.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_type","type":"[FilterableShippingOptionTypeProps](../../../interfaces/fulfillment.FilterableShippingOptionTypeProps/page.mdx)","description":"The filters to apply on the retrieved shipping option types.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"[FilterableShippingOptionRuleProps](../../../interfaces/fulfillment.FilterableShippingOptionRuleProps/page.mdx)","description":"The filters to apply on the retrieved shipping option rules.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShLine truncated
## Returns
@@ -61,7 +61,7 @@ const shippingProfiles =
## Parameters
<TypeList types={[{"name":"filters","type":"[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where eachLine truncated
<TypeList types={[{"name":"filters","type":"[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)","description":"The filters to apply on the retrieved shipping profiles.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"The IDs to filter the shipping profiles by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string` \\| `string`[] \\| [OperatorMap](../../../types/fulfillment.OperatorMap/page.mdx)&#60;string \\| string[]&#62;","description":"Filter the shipping profiles by their type.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_options","type":"[FilterableShippingOptionProps](../../../interfaces/fulfillment.FilterableShippingOptionProps/page.mdx)","description":"The filters to apply on the retrieved shipping options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx) \\| [BaseFilterable](../../../interfaces/fulfillment.BaseFilterable/page.mdx)&#60;[FilterableShippingProfileProps](../../../interfaces/fulfillment.FilterableShippingProfileProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where eachLine truncated
## Returns
@@ -43,7 +43,7 @@ const fulfillment =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[FulfillmentDTO](../../../interfaces/fulfillment.FulfillmentDTO/page.mdx)&#62;","description":"The configurations determining how the fulfillment is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicatLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[FulfillmentDTO](../../../interfaces/fulfillment.FulfillmentDTO/page.mdx)&#62;","description":"The configurations determining how the fulfillment is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A stLine truncated
## Returns
@@ -23,9 +23,8 @@ This method retrieves a fulfillment set by its ID.
A simple example that retrieves a fulfillment set by its ID:
```ts
const fulfillmentSet = await fulfillmentModuleService.retrieveFulfillmentSet(
"fuset_123"
)
const fulfillmentSet =
await fulfillmentModuleService.retrieveFulfillmentSet("fuset_123")
```
To specify relations that should be retrieved:
@@ -41,7 +40,7 @@ const fulfillmentSet = await fulfillmentModuleService.retrieveFulfillmentSet(
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[FulfillmentSetDTO](../../../interfaces/fulfillment.FulfillmentSetDTO/page.mdx)&#62;","description":"The configurations determining how the fulfillment set is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a fulfillment set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description"Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[FulfillmentSetDTO](../../../interfaces/fulfillment.FulfillmentSetDTO/page.mdx)&#62;","description":"The configurations determining how the fulfillment set is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a fulfillment set.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","Line truncated
## Returns
@@ -38,7 +38,7 @@ const geoZone =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[GeoZoneDTO](../../../interfaces/fulfillment.GeoZoneDTO/page.mdx)&#62;","description":"The configurations determining how the geo zone is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a geo zone.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating the idempotenLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the geo zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[GeoZoneDTO](../../../interfaces/fulfillment.GeoZoneDTO/page.mdx)&#62;","description":"The configurations determining how the geo zone is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a geo zone.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indicating tLine truncated
## Returns
@@ -43,7 +43,7 @@ const serviceZone =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ServiceZoneDTO](../../../interfaces/fulfillment.ServiceZoneDTO/page.mdx)&#62;","description":"The configurations determining how the service zone is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a service zone.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"A string indiLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the service zone.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ServiceZoneDTO](../../../interfaces/fulfillment.ServiceZoneDTO/page.mdx)&#62;","description":"The configurations determining how the service zone is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a service zone.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description":"ALine truncated
## Returns
@@ -43,7 +43,7 @@ const shippingOption =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingOptionDTO](../../../interfaces/fulfillment.ShippingOptionDTO/page.mdx)&#62;","description":"The configurations determining how the shipping option is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","description"Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingOptionDTO](../../../interfaces/fulfillment.ShippingOptionDTO/page.mdx)&#62;","description":"The configurations determining how the shipping option is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping option.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","Line truncated
## Returns
@@ -43,7 +43,7 @@ const shippingOptionRule =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingOptionRuleDTO](../../../interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx)&#62;","description":"The configurations determining how the shipping option rule is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping option rule.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingOptionRuleDTO](../../../interfaces/fulfillment.ShippingOptionRuleDTO/page.mdx)&#62;","description":"The configurations determining how the shipping option rule is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping option rule.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKLine truncated
## Returns
@@ -43,7 +43,7 @@ const shippingOptionType =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingOptionTypeDTO](../../../interfaces/fulfillment.ShippingOptionTypeDTO/page.mdx)&#62;","description":"The configurations determining how the shipping option type is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping option type.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping option type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingOptionTypeDTO](../../../interfaces/fulfillment.ShippingOptionTypeDTO/page.mdx)&#62;","description":"The configurations determining how the shipping option type is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping option type.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKLine truncated
## Returns
@@ -43,7 +43,7 @@ const shippingProfile =
## Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingProfileDTO](../../../interfaces/fulfillment.ShippingProfileDTO/page.mdx)&#62;","description":"The configurations determining how the shipping profile is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`string`","descripLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the shipping profile.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/fulfillment.FindConfig/page.mdx)&#60;[ShippingProfileDTO](../../../interfaces/fulfillment.ShippingProfileDTO/page.mdx)&#62;","description":"The configurations determining how the shipping profile is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a shipping profile.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/fulfillment.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/fulfillment.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"`strinLine truncated
## Returns
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The fulfillment to be created.
<TypeList types={[{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit&#60;[CreateFulfillmentAddressDTO](../fulfillment.CreateFulfillmentAddressDTO/page.mdx), \"fulfillment_id\"&#62;","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"`null` \\| `string`","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit&#60;[CreateFulfillmentItemDTO](../fulfillment.CreateFulfillmentItemDTO/page.mdx), \"fulfillment_id\"&#62;[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"[StockLocationDTO](../../types/fulfillment.StockLocationDTO/page.mdx)","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"",Line truncated
<TypeList types={[{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"Omit&#60;[CreateFulfillmentAddressDTO](../fulfillment.CreateFulfillmentAddressDTO/page.mdx), \"fulfillment_id\"&#62;","description":"The address associated with the fulfillment. It's used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"company","type":"`null` \\| `string`","description":"The company of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"The first name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"The last name of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`null` \\| `string`","description":"The first line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"The second line of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"The city of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The ISO 2 character country code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"The province of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"The postal code of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"The phone of the fulfillment address.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"Omit&#60;[CreateFulfillmentItemDTO](../fulfillment.CreateFulfillmentItemDTO/page.mdx), \"fulfillment_id\"&#62;[]","description":"The items associated with the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"title","type":"`string`","description":"The title of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The SKU of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"barcode","type":"`string`","description":"The barcode of the fulfillment item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`null` \\| `string`","description":"The associated line item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_item_id","type":"`null` \\| `string`","description":"The associated inventory item's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"location","type":"[StockLocationDTO](../../types/fulfillment.StockLocationDTO/page.mdx)","description":"The associated location's data.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the stock location.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record<string, unknown>` \\| `null`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_id","type":"`string`","description":"The associated address's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_sets","type":"[FulfillmentSetDTO](../fulfillment.FulfillmentSetDTO/page.mdx)[]","description":"Fulfillment sets for the location","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment set.","optional":false,"defaultValue":"",Line truncated
@@ -13,4 +13,4 @@ which provides correct typing of field names in its properties.
<TypeList types={[{"name":"Entity","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`Record<string, \"ASC\" \\| \"DESC\" \\| string & object>`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
<TypeList types={[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[FindConfigOrder](../../types/fulfillment.FindConfigOrder/page.mdx)","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FindConfig"/>
@@ -6,15 +6,17 @@ import { TypeList } from "docs-ui"
# IBigNumber
## Properties
- [numeric](page.mdx#numeric)
- [raw](page.mdx#raw)
- [bigNumber](page.mdx#bignumber)
## Methods
- [toJSON](../../IBigNumber/methods/fulfillment.IBigNumber.toJSON/page.mdx)
- [valueOf](../../IBigNumber/methods/fulfillment.IBigNumber.valueOf/page.mdx)
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
## Properties
- [bigNumber](page.mdx#bignumber)
- [numeric](page.mdx#numeric)
- [raw](page.mdx#raw)
___
<TypeList types={[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IBigNumber"/>
@@ -19,69 +19,69 @@ The main service interface for the Fulfillment Module.
## Methods
- [retrieveFulfillmentSet](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillmentSet/page.mdx)
- [listFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillmentSets/page.mdx)
- [listAndCountFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountFulfillmentSets/page.mdx)
- [cancelFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx)
- [createFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx)
- [createFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillmentSets/page.mdx)
- [updateFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateFulfillmentSets/page.mdx)
- [deleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets/page.mdx)
- [softDeleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteFulfillmentSets/page.mdx)
- [restoreFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreFulfillmentSets/page.mdx)
- [retrieveServiceZone](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveServiceZone/page.mdx)
- [listServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listServiceZones/page.mdx)
- [listAndCountServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountServiceZones/page.mdx)
- [createServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createServiceZones/page.mdx)
- [updateServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateServiceZones/page.mdx)
- [upsertServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertServiceZones/page.mdx)
- [deleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteServiceZones/page.mdx)
- [softDeleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteServiceZones/page.mdx)
- [restoreServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreServiceZones/page.mdx)
- [retrieveGeoZone](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveGeoZone/page.mdx)
- [listGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listGeoZones/page.mdx)
- [listAndCountGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountGeoZones/page.mdx)
- [createGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createGeoZones/page.mdx)
- [updateGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateGeoZones/page.mdx)
- [createReturnFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createReturnFulfillment/page.mdx)
- [createServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createServiceZones/page.mdx)
- [createShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptionRules/page.mdx)
- [createShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptions/page.mdx)
- [createShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles/page.mdx)
- [deleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteFulfillmentSets/page.mdx)
- [deleteGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteGeoZones/page.mdx)
- [softDeleteGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteGeoZones/page.mdx)
- [restoreGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreGeoZones/page.mdx)
- [retrieveShippingOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOption/page.mdx)
- [deleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteServiceZones/page.mdx)
- [deleteShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptionRules/page.mdx)
- [deleteShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptions/page.mdx)
- [deleteShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptionTypes/page.mdx)
- [deleteShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingProfiles/page.mdx)
- [listAndCountFulfillments](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountFulfillments/page.mdx)
- [listAndCountFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountFulfillmentSets/page.mdx)
- [listAndCountGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountGeoZones/page.mdx)
- [listAndCountServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountServiceZones/page.mdx)
- [listAndCountShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptionRules/page.mdx)
- [listAndCountShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptions/page.mdx)
- [listAndCountShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptionTypes/page.mdx)
- [listAndCountShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingProfiles/page.mdx)
- [listFulfillmentProviders](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillmentProviders/page.mdx)
- [listFulfillments](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillments/page.mdx)
- [listFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillmentSets/page.mdx)
- [listGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listGeoZones/page.mdx)
- [listServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listServiceZones/page.mdx)
- [listShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionRules/page.mdx)
- [listShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptions/page.mdx)
- [listShippingOptionsForContext](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionsForContext/page.mdx)
- [listAndCountShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptions/page.mdx)
- [createShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptions/page.mdx)
- [updateShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptions/page.mdx)
- [upsertShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingOptions/page.mdx)
- [deleteShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptions/page.mdx)
- [softDeleteShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingOptions/page.mdx)
- [restoreShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingOptions/page.mdx)
- [retrieveShippingProfile](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingProfile/page.mdx)
- [listShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingProfiles/page.mdx)
- [listAndCountShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingProfiles/page.mdx)
- [createShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingProfiles/page.mdx)
- [updateShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingProfiles/page.mdx)
- [deleteShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingProfiles/page.mdx)
- [upsertShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingProfiles/page.mdx)
- [softDeleteShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingProfiles/page.mdx)
- [restoreShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingProfiles/page.mdx)
- [retrieveShippingOptionRule](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOptionRule/page.mdx)
- [listShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionRules/page.mdx)
- [listAndCountShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptionRules/page.mdx)
- [createShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createShippingOptionRules/page.mdx)
- [updateShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptionRules/page.mdx)
- [deleteShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptionRules/page.mdx)
- [retrieveShippingOptionType](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOptionType/page.mdx)
- [listShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingOptionTypes/page.mdx)
- [listAndCountShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountShippingOptionTypes/page.mdx)
- [deleteShippingOptionTypes](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.deleteShippingOptionTypes/page.mdx)
- [listShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listShippingProfiles/page.mdx)
- [restoreFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreFulfillmentSets/page.mdx)
- [restoreGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreGeoZones/page.mdx)
- [restoreServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreServiceZones/page.mdx)
- [restoreShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingOptions/page.mdx)
- [restoreShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.restoreShippingProfiles/page.mdx)
- [retrieveFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillment/page.mdx)
- [listFulfillments](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillments/page.mdx)
- [listAndCountFulfillments](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listAndCountFulfillments/page.mdx)
- [createFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createFulfillment/page.mdx)
- [createReturnFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.createReturnFulfillment/page.mdx)
- [updateFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateFulfillment/page.mdx)
- [cancelFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.cancelFulfillment/page.mdx)
- [retrieveFulfillmentOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillmentOptions/page.mdx)
- [validateFulfillmentOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentOption/page.mdx)
- [retrieveFulfillmentSet](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveFulfillmentSet/page.mdx)
- [retrieveGeoZone](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveGeoZone/page.mdx)
- [retrieveServiceZone](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveServiceZone/page.mdx)
- [retrieveShippingOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOption/page.mdx)
- [retrieveShippingOptionRule](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOptionRule/page.mdx)
- [retrieveShippingOptionType](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingOptionType/page.mdx)
- [retrieveShippingProfile](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.retrieveShippingProfile/page.mdx)
- [softDeleteFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteFulfillmentSets/page.mdx)
- [softDeleteGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteGeoZones/page.mdx)
- [softDeleteServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteServiceZones/page.mdx)
- [softDeleteShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingOptions/page.mdx)
- [softDeleteShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.softDeleteShippingProfiles/page.mdx)
- [updateFulfillment](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateFulfillment/page.mdx)
- [updateFulfillmentSets](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateFulfillmentSets/page.mdx)
- [updateGeoZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateGeoZones/page.mdx)
- [updateServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateServiceZones/page.mdx)
- [updateShippingOptionRules](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptionRules/page.mdx)
- [updateShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingOptions/page.mdx)
- [updateShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.updateShippingProfiles/page.mdx)
- [upsertServiceZones](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertServiceZones/page.mdx)
- [upsertShippingOptions](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingOptions/page.mdx)
- [upsertShippingProfiles](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.upsertShippingProfiles/page.mdx)
- [validateFulfillmentData](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentData/page.mdx)
- [validateFulfillmentOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateFulfillmentOption/page.mdx)
- [validateShippingOption](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.validateShippingOption/page.mdx)
- [listFulfillmentProviders](../../IFulfillmentModuleService/methods/fulfillment.IFulfillmentModuleService.listFulfillmentProviders/page.mdx)
@@ -8,7 +8,7 @@ import { TypeList } from "docs-ui"
## Methods
- [save](../../IMessageAggregator/methods/fulfillment.IMessageAggregator.save/page.mdx)
- [getMessages](../../IMessageAggregator/methods/fulfillment.IMessageAggregator.getMessages/page.mdx)
- [clearMessages](../../IMessageAggregator/methods/fulfillment.IMessageAggregator.clearMessages/page.mdx)
- [getMessages](../../IMessageAggregator/methods/fulfillment.IMessageAggregator.getMessages/page.mdx)
- [save](../../IMessageAggregator/methods/fulfillment.IMessageAggregator.save/page.mdx)
- [saveRawMessageData](../../IMessageAggregator/methods/fulfillment.IMessageAggregator.saveRawMessageData/page.mdx)
@@ -6,12 +6,14 @@ import { TypeList } from "docs-ui"
# IModuleService
## Properties
- [\_\_hooks](page.mdx#__hooks)
## Methods
- [\_\_joinerConfig](../../IModuleService/methods/fulfillment.IModuleService.__joinerConfig/page.mdx)
## Properties
- [\_\_hooks](page.mdx#__hooks)
___
<TypeList types={[{"name":"__hooks","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"onApplicationStart","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"onApplicationPrepareShutdown","type":"() => Promise&#60;void&#62;","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="IModuleService"/>
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The order change action details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../fulfillment.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","tLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order change action","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change_id","type":"`null` \\| `string`","description":"The ID of the associated order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_change","type":"`null` \\| [OrderChangeDTO](../fulfillment.OrderChangeDTO/page.mdx)","description":"The associated order change","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","tLine truncated
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The order change details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optiLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order change","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the associated return order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"exchange_id","type":"`string`","description":"The ID of the associated exchange order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_id","type":"`string`","description":"The ID of the associated claim order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optiLine truncated
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The claim details.
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../types/fulfillment.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumbLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The claim's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[OrderClaimType](../../types/fulfillment.OrderClaimType/page.mdx)","description":"The claim's type.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the claim is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The claim's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"`any`[]","description":"The items to be received from the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer\nif the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumbLine truncated
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The order details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultVLine truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultVLine truncated
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The exchange details.
<TypeList types={[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The exchange's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_version","type":"`number`","description":"The version of the order when the exchange is applied.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The exchange's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"additional_items","type":"`any`[]","description":"The items to be sent to the customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":Line truncated
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The order transaction details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order."Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the associated order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The currency of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"When the order was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"When the order was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"original_item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The original item tax total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item total of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_subtotal","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item subtotal of the order.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"item_tax_total","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The item tax total of the order."Line truncated
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"
The return details.
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../types/fulfillment.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../fulfillment.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_refund_amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable"Line truncated
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ReturnStatus](../../types/fulfillment.ReturnStatus/page.mdx)","description":"The status of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[OrderReturnItemDTO](../fulfillment.OrderReturnItemDTO/page.mdx)[]","description":"The items of the return","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order return item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The associated return's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"The associated order's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_id","type":"`string`","description":"The associated line item's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the item to return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason_id","type":"`null` \\| `string`","description":"The associated reason's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"received_quantity","type":"`number`","description":"The received quantity of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the return item.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The return's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_refund_amount","type":"[BigNumberValue](../../types/fulfillment.BigNumberValue/page.mdx)","description":"The raw refund amount of the return.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"numeric","type":"`number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"raw","type":"[BigNumberRawValue](../../types/fulfillment.BigNumberRawValue/page.mdx)","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"value","type":"`string` \\| `number`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"bigNumber","type":"`BigNumber`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[OrderDTO](../fulfillment.OrderDTO/page.mdx)","description":"The associated order.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`number`","description":"The version of the order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../types/fulfillment.OrderStatus/page.mdx)","description":"The status of the order.","optional":false,"defaultValue":"","expandable"Line truncated
@@ -6,6 +6,6 @@ import { TypeList } from "docs-ui"
# ChangeActionType
**ChangeActionType**: `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"DELIVER_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"`
**ChangeActionType**: `"CANCEL_RETURN_ITEM"` \| `"FULFILL_ITEM"` \| `"DELIVER_ITEM"` \| `"CANCEL_ITEM_FULFILLMENT"` \| `"ITEM_ADD"` \| `"ITEM_REMOVE"` \| `"ITEM_UPDATE"` \| `"RECEIVE_DAMAGED_RETURN_ITEM"` \| `"RECEIVE_RETURN_ITEM"` \| `"RETURN_ITEM"` \| `"SHIPPING_ADD"` \| `"SHIPPING_REMOVE"` \| `"SHIP_ITEM"` \| `"WRITE_OFF_ITEM"` \| `"REINSTATE_ITEM"` \| `"TRANSFER_CUSTOMER"`
The change action's type.
@@ -0,0 +1,11 @@
---
displayed_sidebar: fulfillmentReference
---
import { TypeList } from "docs-ui"
# FindConfigOrder
**FindConfigOrder**: `object`
Temporary type fixing to allow any level of orders until we get to properly clean all the types