@mercurjs/docs 2.2.0-canary.44 → 2.2.0-canary.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21,12 +21,16 @@ await addSellerShippingMethodToCartWorkflow(container).run({
21
21
  ## Input
22
22
 
23
23
  <ParamField body="cart_id" type="string" required>The cart to add shipping methods to.</ParamField>
24
- <ParamField body="options" type="object[]" required>Shipping options to add as methods.
24
+
25
+ <ParamField body="options" type="object[]" required>
26
+ Shipping options to add as methods.
27
+
25
28
  <Expandable title="properties">
26
29
  <ParamField body="id" type="string" required>The shipping option ID; must have a calculated price for the cart.</ParamField>
27
30
  <ParamField body="data" type="object">Custom method data validated by the fulfillment provider.</ParamField>
28
31
  </Expandable>
29
32
  </ParamField>
33
+
30
34
  <ParamField body="additional_data" type="object">Custom data passed through to the workflow hooks.</ParamField>
31
35
 
32
36
  ## Result
@@ -23,13 +23,17 @@ const { result } = await batchCommissionRulesWorkflow(container).run({
23
23
  ## Input
24
24
 
25
25
  <ParamField body="commission_rate_id" type="string" required>The commission rate the rules belong to.</ParamField>
26
- <ParamField body="create" type="object[]">Rules to create.
26
+ <ParamField body="create" type="object[]">
27
+ Rules to create.
28
+
27
29
  <Expandable title="properties">
28
30
  <ParamField body="reference" type="string" required>Entity type the rule targets (e.g. `seller`, `product_category`, `product_type`).</ParamField>
29
31
  <ParamField body="reference_id" type="string" required>ID of the referenced entity.</ParamField>
30
32
  </Expandable>
31
33
  </ParamField>
32
- <ParamField body="update" type="object[]">Rules to update.
34
+ <ParamField body="update" type="object[]">
35
+ Rules to update.
36
+
33
37
  <Expandable title="properties">
34
38
  <ParamField body="id" type="string" required>The rule to update.</ParamField>
35
39
  <ParamField body="reference" type="string">New reference type.</ParamField>
@@ -23,13 +23,17 @@ const { result } = await batchOfferInventoryItemsWorkflow(container).run({
23
23
  ## Input
24
24
 
25
25
  <ParamField body="offer_id" type="string" required>The offer whose inventory links are managed; fails if not found.</ParamField>
26
- <ParamField body="create" type="object[]">Links to create; the inventory items must exist and not appear in `update`/`delete`.
26
+ <ParamField body="create" type="object[]">
27
+ Links to create; the inventory items must exist and not appear in `update`/`delete`.
28
+
27
29
  <Expandable title="properties">
28
30
  <ParamField body="inventory_item_id" type="string" required>The inventory item to link.</ParamField>
29
31
  <ParamField body="required_quantity" type="number">Units consumed per offer unit; defaults to `1`.</ParamField>
30
32
  </Expandable>
31
33
  </ParamField>
32
- <ParamField body="update" type="object[]">Existing links to update.
34
+ <ParamField body="update" type="object[]">
35
+ Existing links to update.
36
+
33
37
  <Expandable title="properties">
34
38
  <ParamField body="inventory_item_id" type="string" required>The linked inventory item.</ParamField>
35
39
  <ParamField body="required_quantity" type="number" required>New units consumed per offer unit.</ParamField>
@@ -31,7 +31,9 @@ const { result } = await createOffersWorkflow(container).run({
31
31
 
32
32
  ## Input
33
33
 
34
- <ParamField body="offers" type="object[]" required>Offers to create.
34
+ <ParamField body="offers" type="object[]" required>
35
+ Offers to create.
36
+
35
37
  <Expandable title="properties">
36
38
  <ParamField body="seller_id" type="string" required>The seller that owns the offer.</ParamField>
37
39
  <ParamField body="created_by" type="string" required>ID of the member creating the offer.</ParamField>
@@ -24,7 +24,9 @@ const { result } = await updateOffersWorkflow(container).run({
24
24
 
25
25
  ## Input
26
26
 
27
- <ParamField body="offers" type="object[]" required>Offer updates, keyed by ID.
27
+ <ParamField body="offers" type="object[]" required>
28
+ Offer updates, keyed by ID.
29
+
28
30
  <Expandable title="properties">
29
31
  <ParamField body="id" type="string" required>The offer to update; fails if not found.</ParamField>
30
32
  <ParamField body="sku" type="string">New SKU.</ParamField>
@@ -21,7 +21,9 @@ const { result } = await getOrderGroupsListWorkflow(container).run({
21
21
  ## Input
22
22
 
23
23
  <ParamField body="fields" type="string[]" required>Fields to retrieve; merged with the defaults needed for status aggregation.</ParamField>
24
- <ParamField body="variables" type="object">Query filters plus pagination.
24
+ <ParamField body="variables" type="object">
25
+ Query filters plus pagination.
26
+
25
27
  <Expandable title="properties">
26
28
  <ParamField body="skip" type="number">Number of groups to skip.</ParamField>
27
29
  <ParamField body="take" type="number">Number of groups to return.</ParamField>
@@ -21,7 +21,9 @@ await processPayoutForWebhookWorkflow(container).run({
21
21
  ## Input
22
22
 
23
23
  <ParamField body="action" type="string" required>One of `account.activated`, `account.restricted`, `account.rejected`, `payout.processing`, `payout.paid`, `payout.failed`, `payout.canceled`, `not_supported`.</ParamField>
24
- <ParamField body="data" type="object">Event target; nothing happens when omitted.
24
+ <ParamField body="data" type="object">
25
+ Event target; nothing happens when omitted.
26
+
25
27
  <Expandable title="properties">
26
28
  <ParamField body="id" type="string" required>The ID of the payout account (for `account.*` actions) or the payout (for `payout.*` actions).</ParamField>
27
29
  </Expandable>
@@ -108,4 +108,3 @@ The full, valid set is typed as `WidgetZoneId` and generated into `@mercurjs/ven
108
108
  Add a store-setup field and persist it through a workflow hook.
109
109
  </Card>
110
110
  </CardGroup>
111
- </content>
@@ -108,4 +108,3 @@ export default defineNavigationConfig({
108
108
  Inject a component into a built-in page.
109
109
  </Card>
110
110
  </CardGroup>
111
- </content>
@@ -186,4 +186,3 @@ The SDK derives the fetch query from `link` and merges it into the built-in quer
186
186
  Inject a component at a built-in zone.
187
187
  </Card>
188
188
  </CardGroup>
189
- </content>
@@ -251,4 +251,3 @@ seller.custom_fields.tax_id (durable, queryable)
251
251
  Durable, queryable storage for the data your hook writes.
252
252
  </Card>
253
253
  </CardGroup>
254
- </content>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mercurjs/docs",
3
- "version": "2.2.0-canary.44",
3
+ "version": "2.2.0-canary.46",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "https://github.com/mercurjs/mercur",