@mercurjs/docs 2.2.0-canary.40
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.
- package/README.md +24 -0
- package/content/blocks.mdx +209 -0
- package/content/learn/architecture.mdx +215 -0
- package/content/learn/attributes.mdx +89 -0
- package/content/learn/blocks.mdx +99 -0
- package/content/learn/commissions.mdx +175 -0
- package/content/learn/concepts.mdx +84 -0
- package/content/learn/installation.mdx +117 -0
- package/content/learn/introduction.mdx +71 -0
- package/content/learn/offers.mdx +78 -0
- package/content/learn/order-groups.mdx +114 -0
- package/content/learn/payouts.mdx +175 -0
- package/content/learn/product-requests.mdx +82 -0
- package/content/learn/products.mdx +79 -0
- package/content/learn/registry.mdx +155 -0
- package/content/learn/seller-members.mdx +62 -0
- package/content/learn/sellers.mdx +118 -0
- package/content/migration/from-1-x-to-2-0.mdx +152 -0
- package/content/migration/from-2-0-to-2-1.mdx +105 -0
- package/content/migration/overview.mdx +58 -0
- package/content/references/api/admin/commission-rates/batch-commission-rules.mdx +70 -0
- package/content/references/api/admin/commission-rates/create-commission-rate.mdx +95 -0
- package/content/references/api/admin/commission-rates/delete-commission-rate.mdx +40 -0
- package/content/references/api/admin/commission-rates/list-commission-rates.mdx +92 -0
- package/content/references/api/admin/commission-rates/retrieve-commission-rate.mdx +70 -0
- package/content/references/api/admin/commission-rates/update-commission-rate.mdx +84 -0
- package/content/references/api/admin/members/list-members.mdx +61 -0
- package/content/references/api/admin/offers/batch-create-offers.mdx +130 -0
- package/content/references/api/admin/offers/delete-offer.mdx +40 -0
- package/content/references/api/admin/offers/list-offers.mdx +106 -0
- package/content/references/api/admin/offers/retrieve-offer.mdx +82 -0
- package/content/references/api/admin/order-groups/list-order-groups.mdx +77 -0
- package/content/references/api/admin/order-groups/retrieve-order-group.mdx +56 -0
- package/content/references/api/admin/orders/get-order-commission-lines.mdx +65 -0
- package/content/references/api/admin/orders/get-order-order-group.mdx +56 -0
- package/content/references/api/admin/orders/list-orders.mdx +79 -0
- package/content/references/api/admin/payouts/list-payouts.mdx +75 -0
- package/content/references/api/admin/payouts/retrieve-payout.mdx +62 -0
- package/content/references/api/admin/product-attributes/create-attribute-value.mdx +76 -0
- package/content/references/api/admin/product-attributes/create-product-attribute.mdx +99 -0
- package/content/references/api/admin/product-attributes/delete-attribute-value.mdx +52 -0
- package/content/references/api/admin/product-attributes/delete-product-attribute.mdx +40 -0
- package/content/references/api/admin/product-attributes/list-product-attributes.mdx +91 -0
- package/content/references/api/admin/product-attributes/retrieve-product-attribute.mdx +81 -0
- package/content/references/api/admin/product-attributes/update-attribute-value.mdx +66 -0
- package/content/references/api/admin/product-attributes/update-product-attribute.mdx +76 -0
- package/content/references/api/admin/product-changes/cancel-product-change.mdx +68 -0
- package/content/references/api/admin/product-changes/confirm-product-change.mdx +47 -0
- package/content/references/api/admin/products/batch-product-attributes.mdx +96 -0
- package/content/references/api/admin/products/confirm-product.mdx +59 -0
- package/content/references/api/admin/products/create-product-variant.mdx +78 -0
- package/content/references/api/admin/products/create-product.mdx +169 -0
- package/content/references/api/admin/products/delete-product-variant.mdx +48 -0
- package/content/references/api/admin/products/delete-product.mdx +40 -0
- package/content/references/api/admin/products/list-product-variants.mdx +91 -0
- package/content/references/api/admin/products/list-products.mdx +109 -0
- package/content/references/api/admin/products/preview-product.mdx +78 -0
- package/content/references/api/admin/products/reject-product.mdx +59 -0
- package/content/references/api/admin/products/request-product-changes.mdx +59 -0
- package/content/references/api/admin/products/retrieve-product-variant.mdx +73 -0
- package/content/references/api/admin/products/retrieve-product.mdx +96 -0
- package/content/references/api/admin/products/set-product-sellers.mdx +47 -0
- package/content/references/api/admin/products/update-product-variant.mdx +89 -0
- package/content/references/api/admin/products/update-product.mdx +133 -0
- package/content/references/api/admin/sellers/add-seller-member.mdx +63 -0
- package/content/references/api/admin/sellers/approve-seller.mdx +54 -0
- package/content/references/api/admin/sellers/create-seller.mdx +100 -0
- package/content/references/api/admin/sellers/delete-member-invite.mdx +42 -0
- package/content/references/api/admin/sellers/delete-professional-details.mdx +52 -0
- package/content/references/api/admin/sellers/invite-seller-member.mdx +63 -0
- package/content/references/api/admin/sellers/list-member-invites.mdx +71 -0
- package/content/references/api/admin/sellers/list-seller-members.mdx +71 -0
- package/content/references/api/admin/sellers/list-seller-products.mdx +85 -0
- package/content/references/api/admin/sellers/list-sellers.mdx +96 -0
- package/content/references/api/admin/sellers/remove-seller-member.mdx +42 -0
- package/content/references/api/admin/sellers/resend-member-invite.mdx +55 -0
- package/content/references/api/admin/sellers/retrieve-seller.mdx +81 -0
- package/content/references/api/admin/sellers/suspend-seller.mdx +60 -0
- package/content/references/api/admin/sellers/terminate-seller.mdx +60 -0
- package/content/references/api/admin/sellers/unsuspend-seller.mdx +52 -0
- package/content/references/api/admin/sellers/unterminate-seller.mdx +52 -0
- package/content/references/api/admin/sellers/update-seller.mdx +83 -0
- package/content/references/api/admin/sellers/upsert-payment-details.mdx +88 -0
- package/content/references/api/admin/sellers/upsert-professional-details.mdx +78 -0
- package/content/references/api/admin/sellers/upsert-seller-address.mdx +91 -0
- package/content/references/api/admin.mdx +134 -0
- package/content/references/api/conventions.mdx +109 -0
- package/content/references/api/store/carts/add-line-item.mdx +115 -0
- package/content/references/api/store/carts/add-shipping-methods.mdx +84 -0
- package/content/references/api/store/carts/apply-promotions.mdx +83 -0
- package/content/references/api/store/carts/complete-cart.mdx +98 -0
- package/content/references/api/store/offers/list-offers.mdx +161 -0
- package/content/references/api/store/offers/retrieve-offer.mdx +112 -0
- package/content/references/api/store/order-groups/list-order-groups.mdx +105 -0
- package/content/references/api/store/order-groups/retrieve-order-group.mdx +78 -0
- package/content/references/api/store/product-attributes/list-product-attributes.mdx +134 -0
- package/content/references/api/store/product-attributes/retrieve-product-attribute.mdx +78 -0
- package/content/references/api/store/product-categories/list-product-categories.mdx +126 -0
- package/content/references/api/store/product-categories/retrieve-product-category.mdx +79 -0
- package/content/references/api/store/products/list-products.mdx +184 -0
- package/content/references/api/store/products/retrieve-product.mdx +107 -0
- package/content/references/api/store/search/search.mdx +136 -0
- package/content/references/api/store/sellers/list-sellers.mdx +105 -0
- package/content/references/api/store/sellers/retrieve-seller.mdx +62 -0
- package/content/references/api/store/shipping-options/list-shipping-options.mdx +74 -0
- package/content/references/api/store.mdx +67 -0
- package/content/references/api/vendor/members/accept-member-invite.mdx +65 -0
- package/content/references/api/vendor/members/retrieve-current-member.mdx +51 -0
- package/content/references/api/vendor/members/update-current-member.mdx +70 -0
- package/content/references/api/vendor/offers/batch-create-offers.mdx +123 -0
- package/content/references/api/vendor/offers/batch-offer-inventory-items.mdx +103 -0
- package/content/references/api/vendor/offers/create-offer.mdx +141 -0
- package/content/references/api/vendor/offers/delete-offer.mdx +51 -0
- package/content/references/api/vendor/offers/list-offers.mdx +125 -0
- package/content/references/api/vendor/offers/retrieve-offer.mdx +74 -0
- package/content/references/api/vendor/offers/update-offer.mdx +82 -0
- package/content/references/api/vendor/orders/cancel-fulfillment.mdx +63 -0
- package/content/references/api/vendor/orders/cancel-order.mdx +56 -0
- package/content/references/api/vendor/orders/complete-order.mdx +55 -0
- package/content/references/api/vendor/orders/create-fulfillment.mdx +76 -0
- package/content/references/api/vendor/orders/create-shipment.mdx +99 -0
- package/content/references/api/vendor/orders/get-order-commission-lines.mdx +66 -0
- package/content/references/api/vendor/orders/list-order-changes.mdx +75 -0
- package/content/references/api/vendor/orders/list-orders.mdx +103 -0
- package/content/references/api/vendor/orders/mark-fulfillment-delivered.mdx +62 -0
- package/content/references/api/vendor/orders/preview-order.mdx +65 -0
- package/content/references/api/vendor/orders/retrieve-order.mdx +84 -0
- package/content/references/api/vendor/payout-accounts/create-onboarding.mdx +68 -0
- package/content/references/api/vendor/payout-accounts/create-payout-account.mdx +59 -0
- package/content/references/api/vendor/payout-accounts/retrieve-payout-account-by-id.mdx +60 -0
- package/content/references/api/vendor/payout-accounts/retrieve-payout-account.mdx +77 -0
- package/content/references/api/vendor/payouts/list-payouts.mdx +90 -0
- package/content/references/api/vendor/payouts/retrieve-payout.mdx +63 -0
- package/content/references/api/vendor/product-attributes/list-product-attributes.mdx +135 -0
- package/content/references/api/vendor/product-attributes/retrieve-product-attribute.mdx +71 -0
- package/content/references/api/vendor/product-variants/list-variants.mdx +136 -0
- package/content/references/api/vendor/products/batch-product-attributes.mdx +104 -0
- package/content/references/api/vendor/products/cancel-product-change.mdx +62 -0
- package/content/references/api/vendor/products/create-product-variant.mdx +92 -0
- package/content/references/api/vendor/products/create-product.mdx +197 -0
- package/content/references/api/vendor/products/delete-product-variant.mdx +68 -0
- package/content/references/api/vendor/products/delete-product.mdx +62 -0
- package/content/references/api/vendor/products/list-product-variants.mdx +114 -0
- package/content/references/api/vendor/products/list-products.mdx +163 -0
- package/content/references/api/vendor/products/preview-product.mdx +61 -0
- package/content/references/api/vendor/products/retrieve-product-variant.mdx +76 -0
- package/content/references/api/vendor/products/retrieve-product.mdx +69 -0
- package/content/references/api/vendor/products/update-product-variant.mdx +104 -0
- package/content/references/api/vendor/products/update-product.mdx +148 -0
- package/content/references/api/vendor/sellers/create-seller.mdx +150 -0
- package/content/references/api/vendor/sellers/delete-professional-details.mdx +54 -0
- package/content/references/api/vendor/sellers/invite-seller-member.mdx +67 -0
- package/content/references/api/vendor/sellers/list-member-invites.mdx +82 -0
- package/content/references/api/vendor/sellers/list-seller-members.mdx +80 -0
- package/content/references/api/vendor/sellers/list-sellers.mdx +71 -0
- package/content/references/api/vendor/sellers/remove-seller-member.mdx +48 -0
- package/content/references/api/vendor/sellers/retrieve-current-seller-member.mdx +59 -0
- package/content/references/api/vendor/sellers/retrieve-current-seller.mdx +69 -0
- package/content/references/api/vendor/sellers/select-seller.mdx +44 -0
- package/content/references/api/vendor/sellers/update-current-seller.mdx +108 -0
- package/content/references/api/vendor/sellers/update-member-role.mdx +51 -0
- package/content/references/api/vendor/sellers/upsert-payment-details.mdx +74 -0
- package/content/references/api/vendor/sellers/upsert-professional-details.mdx +70 -0
- package/content/references/api/vendor/sellers/upsert-seller-address.mdx +81 -0
- package/content/references/api/vendor.mdx +150 -0
- package/content/references/configuration.mdx +155 -0
- package/content/references/modules/commission.mdx +106 -0
- package/content/references/modules/custom-fields.mdx +45 -0
- package/content/references/modules/media.mdx +55 -0
- package/content/references/modules/offer.mdx +64 -0
- package/content/references/modules/payout.mdx +121 -0
- package/content/references/modules/product-attribute.mdx +111 -0
- package/content/references/modules/product-edit.mdx +80 -0
- package/content/references/modules/search.mdx +112 -0
- package/content/references/modules/seller.mdx +175 -0
- package/content/references/overview.mdx +70 -0
- package/content/references/workflows/cart/add-seller-shipping-method-to-cart.mdx +44 -0
- package/content/references/workflows/cart/complete-cart-with-split-orders.mdx +36 -0
- package/content/references/workflows/cart/list-seller-shipping-options-for-cart.mdx +39 -0
- package/content/references/workflows/cart/update-cart-seller-promotions.mdx +42 -0
- package/content/references/workflows/commission/batch-commission-rules.mdx +45 -0
- package/content/references/workflows/commission/create-commission-rates.mdx +41 -0
- package/content/references/workflows/commission/delete-commission-rates.mdx +34 -0
- package/content/references/workflows/commission/refresh-order-commission-lines.mdx +30 -0
- package/content/references/workflows/commission/update-commission-rates.mdx +35 -0
- package/content/references/workflows/media/set-category-images.mdx +41 -0
- package/content/references/workflows/media/set-collection-images.mdx +41 -0
- package/content/references/workflows/member/accept-member-invite.mdx +33 -0
- package/content/references/workflows/member/add-seller-member.mdx +30 -0
- package/content/references/workflows/member/create-member-invites.mdx +34 -0
- package/content/references/workflows/member/delete-member-invite.mdx +24 -0
- package/content/references/workflows/member/remove-seller-member.mdx +28 -0
- package/content/references/workflows/member/resend-member-invite.mdx +28 -0
- package/content/references/workflows/member/update-member-role.mdx +28 -0
- package/content/references/workflows/member/update-member.mdx +35 -0
- package/content/references/workflows/offer/batch-offer-inventory-items.mdx +58 -0
- package/content/references/workflows/offer/create-offers.mdx +63 -0
- package/content/references/workflows/offer/delete-offers.mdx +35 -0
- package/content/references/workflows/offer/update-offers.mdx +51 -0
- package/content/references/workflows/order/cancel-order-fulfillment.mdx +34 -0
- package/content/references/workflows/order/confirm-claim-request.mdx +25 -0
- package/content/references/workflows/order/confirm-exchange-request.mdx +25 -0
- package/content/references/workflows/order/confirm-order-edit-request.mdx +25 -0
- package/content/references/workflows/order/confirm-return-receive.mdx +25 -0
- package/content/references/workflows/order/create-order-fulfillment.mdx +45 -0
- package/content/references/workflows/order-group/get-order-group-detail.mdx +29 -0
- package/content/references/workflows/order-group/get-order-groups-list.mdx +36 -0
- package/content/references/workflows/overview.mdx +72 -0
- package/content/references/workflows/payout/create-onboarding.mdx +36 -0
- package/content/references/workflows/payout/create-payout-account.mdx +33 -0
- package/content/references/workflows/payout/create-payout.mdx +30 -0
- package/content/references/workflows/payout/process-payout-for-webhook.mdx +32 -0
- package/content/references/workflows/product/confirm-products.mdx +46 -0
- package/content/references/workflows/product/create-products.mdx +63 -0
- package/content/references/workflows/product/link-sellers-to-product-category.mdx +40 -0
- package/content/references/workflows/product/link-sellers-to-product.mdx +40 -0
- package/content/references/workflows/product/reject-product.mdx +46 -0
- package/content/references/workflows/product/request-product-change.mdx +46 -0
- package/content/references/workflows/product-attribute/add-product-attributes-to-product.mdx +49 -0
- package/content/references/workflows/product-attribute/create-and-link-product-attributes-to-product.mdx +46 -0
- package/content/references/workflows/product-attribute/create-product-attribute-values.mdx +43 -0
- package/content/references/workflows/product-attribute/create-product-attributes.mdx +56 -0
- package/content/references/workflows/product-attribute/delete-product-attribute-values.mdx +30 -0
- package/content/references/workflows/product-attribute/delete-product-attributes.mdx +30 -0
- package/content/references/workflows/product-attribute/remove-product-attributes-from-product.mdx +29 -0
- package/content/references/workflows/product-attribute/update-product-attribute-values.mdx +44 -0
- package/content/references/workflows/product-attribute/update-product-attributes-on-product.mdx +41 -0
- package/content/references/workflows/product-attribute/update-product-attributes.mdx +48 -0
- package/content/references/workflows/product-attribute/upsert-product-attribute-values.mdx +43 -0
- package/content/references/workflows/product-edit/auto-confirm-product-change.mdx +39 -0
- package/content/references/workflows/product-edit/cancel-product-change.mdx +49 -0
- package/content/references/workflows/product-edit/confirm-product-change.mdx +57 -0
- package/content/references/workflows/product-edit/create-product-change.mdx +72 -0
- package/content/references/workflows/product-edit/reject-product-change.mdx +54 -0
- package/content/references/workflows/product-edit/stage-product-change.mdx +75 -0
- package/content/references/workflows/seller/approve-seller.mdx +34 -0
- package/content/references/workflows/seller/create-seller-account.mdx +59 -0
- package/content/references/workflows/seller/create-seller-defaults.mdx +22 -0
- package/content/references/workflows/seller/create-sellers.mdx +65 -0
- package/content/references/workflows/seller/delete-seller-professional-details.mdx +37 -0
- package/content/references/workflows/seller/delete-sellers.mdx +24 -0
- package/content/references/workflows/seller/invite-seller.mdx +28 -0
- package/content/references/workflows/seller/suspend-seller.mdx +35 -0
- package/content/references/workflows/seller/terminate-seller.mdx +35 -0
- package/content/references/workflows/seller/unsuspend-seller.mdx +34 -0
- package/content/references/workflows/seller/unterminate-seller.mdx +34 -0
- package/content/references/workflows/seller/update-seller-address.mdx +55 -0
- package/content/references/workflows/seller/update-seller-payment-details.mdx +52 -0
- package/content/references/workflows/seller/update-seller-professional-details.mdx +48 -0
- package/content/references/workflows/seller/update-sellers.mdx +57 -0
- package/content/resources/ai/llms.mdx +74 -0
- package/content/resources/ai/mcp.mdx +152 -0
- package/content/resources/ai/overview.mdx +97 -0
- package/content/resources/customization/custom-fields.mdx +182 -0
- package/content/resources/customization/extend-a-workflow.mdx +39 -0
- package/content/resources/customization/extending-panels.mdx +309 -0
- package/content/resources/deployment/medusa-cloud.mdx +167 -0
- package/content/resources/integrations/notifications.mdx +39 -0
- package/content/resources/integrations/search.mdx +122 -0
- package/content/resources/integrations/stripe-connect.mdx +395 -0
- package/content/resources/tutorials/add-a-block.mdx +74 -0
- package/content/resources/tutorials/attributes-and-variant-axes.mdx +111 -0
- package/content/resources/tutorials/build-a-block.mdx +134 -0
- package/content/resources/tutorials/configure-commissions.mdx +127 -0
- package/content/resources/tutorials/custom-api-route.mdx +142 -0
- package/content/resources/tutorials/custom-panel-page.mdx +78 -0
- package/content/resources/tutorials/first-marketplace.mdx +45 -0
- package/content/resources/tutorials/handle-product-requests.mdx +80 -0
- package/content/resources/tutorials/import-export-products.mdx +96 -0
- package/content/resources/tutorials/master-products-and-offers.mdx +89 -0
- package/content/resources/tutorials/recompose-a-page.mdx +129 -0
- package/content/resources/tutorials/replace-panel-components.mdx +116 -0
- package/content/resources/tutorials/seller-payouts-stripe.mdx +89 -0
- package/content/telemetry.mdx +67 -0
- package/content/tools/api-client.mdx +155 -0
- package/content/tools/cli.mdx +196 -0
- package/content/tools/dashboard-sdk.mdx +35 -0
- package/content/user-guide/admin/overview.mdx +23 -0
- package/content/user-guide/admin/stores.mdx +193 -0
- package/content/user-guide/vendor/overview.mdx +23 -0
- package/content/user-guide/vendor/stores.mdx +209 -0
- package/llms.txt +307 -0
- package/package.json +33 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Retrieve Offer"
|
|
3
|
+
api: "GET /vendor/offers/{id}"
|
|
4
|
+
description: "Retrieve one of the seller's offers by its ID."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Returns a single offer owned by the seller; requesting another seller's offer fails.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>
|
|
12
|
+
The offer's ID.
|
|
13
|
+
</ParamField>
|
|
14
|
+
|
|
15
|
+
## Query parameters
|
|
16
|
+
|
|
17
|
+
<ParamField query="fields" type="string">
|
|
18
|
+
Comma-separated fields to include in the response. Prefix with `+`/`-` to add to or remove from the defaults.
|
|
19
|
+
</ParamField>
|
|
20
|
+
|
|
21
|
+
## Response
|
|
22
|
+
|
|
23
|
+
<ResponseField name="offer" type="object">
|
|
24
|
+
<Expandable title="properties">
|
|
25
|
+
<ResponseField name="id" type="string">The offer's ID.</ResponseField>
|
|
26
|
+
<ResponseField name="seller_id" type="string">ID of the owning seller.</ResponseField>
|
|
27
|
+
<ResponseField name="variant_id" type="string">ID of the listed product variant.</ResponseField>
|
|
28
|
+
<ResponseField name="product_id" type="string">ID of the parent product.</ResponseField>
|
|
29
|
+
<ResponseField name="shipping_profile_id" type="string">ID of the shipping profile.</ResponseField>
|
|
30
|
+
<ResponseField name="sku" type="string">The seller's SKU for this listing.</ResponseField>
|
|
31
|
+
<ResponseField name="ean" type="string">EAN barcode.</ResponseField>
|
|
32
|
+
<ResponseField name="upc" type="string">UPC barcode.</ResponseField>
|
|
33
|
+
<ResponseField name="seller" type="object">The seller with `id`, `name`, and `handle`.</ResponseField>
|
|
34
|
+
<ResponseField name="product_variant" type="object">The variant with `id`, `title`, and `sku`.</ResponseField>
|
|
35
|
+
<ResponseField name="shipping_profile" type="object">The shipping profile with `id` and `name`.</ResponseField>
|
|
36
|
+
<ResponseField name="prices" type="object[]">Offer prices with `id`, `amount`, `currency_code`, `min_quantity`, `max_quantity`, and `price_rules`.</ResponseField>
|
|
37
|
+
<ResponseField name="inventory_items" type="object[]">Linked inventory items with `id`, `inventory_item_id`, `required_quantity`, and `sku`.</ResponseField>
|
|
38
|
+
<ResponseField name="metadata" type="object">Custom key-value pairs.</ResponseField>
|
|
39
|
+
</Expandable>
|
|
40
|
+
</ResponseField>
|
|
41
|
+
|
|
42
|
+
<RequestExample>
|
|
43
|
+
```bash cURL
|
|
44
|
+
curl 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
|
|
45
|
+
-H 'Authorization: Bearer <token>' \
|
|
46
|
+
-H 'x-seller-id: <seller_id>'
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
```ts JS Client
|
|
50
|
+
const { offer } = await client.vendor.offers.$id.query({
|
|
51
|
+
$id: "offer_01HXYZ",
|
|
52
|
+
})
|
|
53
|
+
```
|
|
54
|
+
</RequestExample>
|
|
55
|
+
|
|
56
|
+
<ResponseExample>
|
|
57
|
+
```json 200
|
|
58
|
+
{
|
|
59
|
+
"offer": {
|
|
60
|
+
"id": "offer_01HXYZ",
|
|
61
|
+
"seller_id": "sel_01HXYZ",
|
|
62
|
+
"variant_id": "variant_01HXYZ",
|
|
63
|
+
"product_id": "prod_01HXYZ",
|
|
64
|
+
"sku": "ACME-SHIRT-M",
|
|
65
|
+
"prices": [
|
|
66
|
+
{ "id": "price_01HXYZ", "amount": 2500, "currency_code": "usd" }
|
|
67
|
+
],
|
|
68
|
+
"inventory_items": [
|
|
69
|
+
{ "inventory_item_id": "iitem_01HXYZ", "required_quantity": 1 }
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
</ResponseExample>
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Update Offer"
|
|
3
|
+
api: "POST /vendor/offers/{id}"
|
|
4
|
+
description: "Update one of the seller's offers."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Updates the offer directly (no change request) and returns the refreshed offer.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>
|
|
12
|
+
The offer's ID.
|
|
13
|
+
</ParamField>
|
|
14
|
+
|
|
15
|
+
## Body parameters
|
|
16
|
+
|
|
17
|
+
<ParamField body="sku" type="string">
|
|
18
|
+
The seller's SKU for this listing.
|
|
19
|
+
</ParamField>
|
|
20
|
+
|
|
21
|
+
<ParamField body="shipping_profile_id" type="string">
|
|
22
|
+
ID of the shipping profile used to fulfill the offer.
|
|
23
|
+
</ParamField>
|
|
24
|
+
|
|
25
|
+
<ParamField body="prices" type="object[]">
|
|
26
|
+
Prices to upsert; include `id` to update an existing price, omit it to add one.
|
|
27
|
+
<Expandable title="properties">
|
|
28
|
+
<ParamField body="id" type="string">Existing price ID to update.</ParamField>
|
|
29
|
+
<ParamField body="amount" type="number" required>Price amount.</ParamField>
|
|
30
|
+
<ParamField body="currency_code" type="string" required>Currency code, e.g. `usd`.</ParamField>
|
|
31
|
+
<ParamField body="min_quantity" type="number">Minimum quantity for the price to apply; positive integer.</ParamField>
|
|
32
|
+
<ParamField body="max_quantity" type="number">Maximum quantity for the price to apply; positive integer.</ParamField>
|
|
33
|
+
<ParamField body="rules" type="object">Price rules as attribute-to-value pairs.</ParamField>
|
|
34
|
+
</Expandable>
|
|
35
|
+
</ParamField>
|
|
36
|
+
|
|
37
|
+
<ParamField body="metadata" type="object">
|
|
38
|
+
Custom key-value pairs.
|
|
39
|
+
</ParamField>
|
|
40
|
+
|
|
41
|
+
## Response
|
|
42
|
+
|
|
43
|
+
<ResponseField name="offer" type="object">
|
|
44
|
+
<Expandable title="properties">
|
|
45
|
+
<ResponseField name="id" type="string">The offer's ID.</ResponseField>
|
|
46
|
+
<ResponseField name="sku" type="string">The seller's SKU for this listing.</ResponseField>
|
|
47
|
+
<ResponseField name="shipping_profile_id" type="string">ID of the shipping profile.</ResponseField>
|
|
48
|
+
<ResponseField name="prices" type="object[]">The offer's prices after the update.</ResponseField>
|
|
49
|
+
<ResponseField name="inventory_items" type="object[]">Linked inventory items.</ResponseField>
|
|
50
|
+
</Expandable>
|
|
51
|
+
</ResponseField>
|
|
52
|
+
|
|
53
|
+
<RequestExample>
|
|
54
|
+
```bash cURL
|
|
55
|
+
curl -X POST 'http://localhost:9000/vendor/offers/offer_01HXYZ' \
|
|
56
|
+
-H 'Authorization: Bearer <token>' \
|
|
57
|
+
-H 'x-seller-id: <seller_id>' \
|
|
58
|
+
-H 'Content-Type: application/json' \
|
|
59
|
+
-d '{"prices": [{ "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }]}'
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
```ts JS Client
|
|
63
|
+
const { offer } = await client.vendor.offers.$id.mutate({
|
|
64
|
+
$id: "offer_01HXYZ",
|
|
65
|
+
prices: [{ id: "price_01HXYZ", amount: 2300, currency_code: "usd" }],
|
|
66
|
+
})
|
|
67
|
+
```
|
|
68
|
+
</RequestExample>
|
|
69
|
+
|
|
70
|
+
<ResponseExample>
|
|
71
|
+
```json 200
|
|
72
|
+
{
|
|
73
|
+
"offer": {
|
|
74
|
+
"id": "offer_01HXYZ",
|
|
75
|
+
"sku": "ACME-SHIRT-M",
|
|
76
|
+
"prices": [
|
|
77
|
+
{ "id": "price_01HXYZ", "amount": 2300, "currency_code": "usd" }
|
|
78
|
+
]
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
</ResponseExample>
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Cancel Fulfillment"
|
|
3
|
+
api: "POST /vendor/orders/{id}/fulfillments/{fulfillment_id}/cancel"
|
|
4
|
+
description: "Cancel a fulfillment on the order."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Cancels the fulfillment and returns the updated order.
|
|
8
|
+
|
|
9
|
+
<Note>A fulfillment cannot be canceled after it has been shipped.</Note>
|
|
10
|
+
|
|
11
|
+
## Path parameters
|
|
12
|
+
|
|
13
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
14
|
+
<ParamField path="fulfillment_id" type="string" required>The fulfillment's ID.</ParamField>
|
|
15
|
+
|
|
16
|
+
## Query parameters
|
|
17
|
+
|
|
18
|
+
<ParamField query="fields" type="string">Comma-separated list of fields to include in the returned order, prefix with `+`/`-` to add or remove from defaults.</ParamField>
|
|
19
|
+
|
|
20
|
+
## Response
|
|
21
|
+
|
|
22
|
+
<ResponseField name="order" type="object">
|
|
23
|
+
<Expandable title="properties">
|
|
24
|
+
<ResponseField name="id" type="string">The order's ID.</ResponseField>
|
|
25
|
+
<ResponseField name="status" type="string">The order's status.</ResponseField>
|
|
26
|
+
<ResponseField name="fulfillments" type="object[]">The order's fulfillments, including the canceled one.</ResponseField>
|
|
27
|
+
<ResponseField name="items" type="object[]">The order's line items.</ResponseField>
|
|
28
|
+
</Expandable>
|
|
29
|
+
</ResponseField>
|
|
30
|
+
|
|
31
|
+
<RequestExample>
|
|
32
|
+
```bash cURL
|
|
33
|
+
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments/ful_01HXYZABCDEF/cancel' \
|
|
34
|
+
-H 'Authorization: Bearer <token>' \
|
|
35
|
+
-H 'x-seller-id: <seller_id>'
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
```ts JS Client
|
|
39
|
+
const { order } =
|
|
40
|
+
await client.vendor.orders.$id.fulfillments.$fulfillment_id.cancel.mutate({
|
|
41
|
+
$id: "order_01HXYZABCDEF",
|
|
42
|
+
$fulfillment_id: "ful_01HXYZABCDEF",
|
|
43
|
+
})
|
|
44
|
+
```
|
|
45
|
+
</RequestExample>
|
|
46
|
+
|
|
47
|
+
<ResponseExample>
|
|
48
|
+
```json 200
|
|
49
|
+
{
|
|
50
|
+
"order": {
|
|
51
|
+
"id": "order_01HXYZABCDEF",
|
|
52
|
+
"display_id": 42,
|
|
53
|
+
"status": "pending",
|
|
54
|
+
"fulfillments": [
|
|
55
|
+
{
|
|
56
|
+
"id": "ful_01HXYZABCDEF",
|
|
57
|
+
"canceled_at": "2026-06-04T10:00:00.000Z"
|
|
58
|
+
}
|
|
59
|
+
]
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
</ResponseExample>
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Cancel Order"
|
|
3
|
+
api: "POST /vendor/orders/{id}/cancel"
|
|
4
|
+
description: "Cancel the order."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Cancels the order on behalf of the seller and returns the updated order.
|
|
8
|
+
|
|
9
|
+
<Note>An order can only be canceled if it has no fulfillments or captured payments that block cancellation.</Note>
|
|
10
|
+
|
|
11
|
+
## Path parameters
|
|
12
|
+
|
|
13
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
14
|
+
|
|
15
|
+
## Query parameters
|
|
16
|
+
|
|
17
|
+
<ParamField query="fields" type="string">Comma-separated list of fields to include in the returned order, prefix with `+`/`-` to add or remove from defaults.</ParamField>
|
|
18
|
+
|
|
19
|
+
## Response
|
|
20
|
+
|
|
21
|
+
<ResponseField name="order" type="object">
|
|
22
|
+
<Expandable title="properties">
|
|
23
|
+
<ResponseField name="id" type="string">The order's ID.</ResponseField>
|
|
24
|
+
<ResponseField name="status" type="string">The order's status, now `canceled`.</ResponseField>
|
|
25
|
+
<ResponseField name="canceled_at" type="string">Cancellation timestamp.</ResponseField>
|
|
26
|
+
<ResponseField name="items" type="object[]">The order's line items.</ResponseField>
|
|
27
|
+
<ResponseField name="summary" type="object">Order totals summary.</ResponseField>
|
|
28
|
+
</Expandable>
|
|
29
|
+
</ResponseField>
|
|
30
|
+
|
|
31
|
+
<RequestExample>
|
|
32
|
+
```bash cURL
|
|
33
|
+
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/cancel' \
|
|
34
|
+
-H 'Authorization: Bearer <token>' \
|
|
35
|
+
-H 'x-seller-id: <seller_id>'
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
```ts JS Client
|
|
39
|
+
const { order } = await client.vendor.orders.$id.cancel.mutate({
|
|
40
|
+
$id: "order_01HXYZABCDEF",
|
|
41
|
+
})
|
|
42
|
+
```
|
|
43
|
+
</RequestExample>
|
|
44
|
+
|
|
45
|
+
<ResponseExample>
|
|
46
|
+
```json 200
|
|
47
|
+
{
|
|
48
|
+
"order": {
|
|
49
|
+
"id": "order_01HXYZABCDEF",
|
|
50
|
+
"display_id": 42,
|
|
51
|
+
"status": "canceled",
|
|
52
|
+
"canceled_at": "2026-06-05T10:00:00.000Z"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
</ResponseExample>
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Complete Order"
|
|
3
|
+
api: "POST /vendor/orders/{id}/complete"
|
|
4
|
+
description: "Mark the order as completed."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Completes the order and returns the updated order.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
12
|
+
|
|
13
|
+
## Query parameters
|
|
14
|
+
|
|
15
|
+
<ParamField query="fields" type="string">Comma-separated list of fields to include in the returned order, prefix with `+`/`-` to add or remove from defaults.</ParamField>
|
|
16
|
+
|
|
17
|
+
## Response
|
|
18
|
+
|
|
19
|
+
<ResponseField name="order" type="object">
|
|
20
|
+
<Expandable title="properties">
|
|
21
|
+
<ResponseField name="id" type="string">The order's ID.</ResponseField>
|
|
22
|
+
<ResponseField name="status" type="string">The order's status, now `completed`.</ResponseField>
|
|
23
|
+
<ResponseField name="items" type="object[]">The order's line items.</ResponseField>
|
|
24
|
+
<ResponseField name="summary" type="object">Order totals summary.</ResponseField>
|
|
25
|
+
<ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
|
|
26
|
+
</Expandable>
|
|
27
|
+
</ResponseField>
|
|
28
|
+
|
|
29
|
+
<RequestExample>
|
|
30
|
+
```bash cURL
|
|
31
|
+
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/complete' \
|
|
32
|
+
-H 'Authorization: Bearer <token>' \
|
|
33
|
+
-H 'x-seller-id: <seller_id>'
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
```ts JS Client
|
|
37
|
+
const { order } = await client.vendor.orders.$id.complete.mutate({
|
|
38
|
+
$id: "order_01HXYZABCDEF",
|
|
39
|
+
})
|
|
40
|
+
```
|
|
41
|
+
</RequestExample>
|
|
42
|
+
|
|
43
|
+
<ResponseExample>
|
|
44
|
+
```json 200
|
|
45
|
+
{
|
|
46
|
+
"order": {
|
|
47
|
+
"id": "order_01HXYZABCDEF",
|
|
48
|
+
"display_id": 42,
|
|
49
|
+
"status": "completed",
|
|
50
|
+
"currency_code": "usd",
|
|
51
|
+
"updated_at": "2026-06-05T10:00:00.000Z"
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
</ResponseExample>
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Create Fulfillment"
|
|
3
|
+
api: "POST /vendor/orders/{id}/fulfillments"
|
|
4
|
+
description: "Create a fulfillment for the order's items."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Creates a fulfillment for the specified items from a stock location owned by the seller.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
12
|
+
|
|
13
|
+
## Body parameters
|
|
14
|
+
|
|
15
|
+
<ParamField body="items" type="object[]" required>
|
|
16
|
+
Items to fulfill.
|
|
17
|
+
<Expandable title="properties">
|
|
18
|
+
<ParamField body="id" type="string" required>Line item ID.</ParamField>
|
|
19
|
+
<ParamField body="quantity" type="number" required>Quantity to fulfill; integer, minimum 0.</ParamField>
|
|
20
|
+
</Expandable>
|
|
21
|
+
</ParamField>
|
|
22
|
+
<ParamField body="requires_shipping" type="boolean" required>Whether the fulfillment requires shipping.</ParamField>
|
|
23
|
+
<ParamField body="location_id" type="string" required>ID of the stock location to fulfill from.</ParamField>
|
|
24
|
+
|
|
25
|
+
## Response
|
|
26
|
+
|
|
27
|
+
<ResponseField name="fulfillment" type="object">
|
|
28
|
+
<Expandable title="properties">
|
|
29
|
+
<ResponseField name="id" type="string">The fulfillment's ID.</ResponseField>
|
|
30
|
+
<ResponseField name="location_id" type="string">ID of the stock location fulfilled from.</ResponseField>
|
|
31
|
+
<ResponseField name="requires_shipping" type="boolean">Whether the fulfillment requires shipping.</ResponseField>
|
|
32
|
+
<ResponseField name="packed_at" type="string">When the fulfillment was packed.</ResponseField>
|
|
33
|
+
<ResponseField name="shipped_at" type="string">When the fulfillment was shipped.</ResponseField>
|
|
34
|
+
<ResponseField name="delivered_at" type="string">When the fulfillment was delivered.</ResponseField>
|
|
35
|
+
<ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
|
|
36
|
+
</Expandable>
|
|
37
|
+
</ResponseField>
|
|
38
|
+
|
|
39
|
+
<RequestExample>
|
|
40
|
+
```bash cURL
|
|
41
|
+
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments' \
|
|
42
|
+
-H 'Authorization: Bearer <token>' \
|
|
43
|
+
-H 'x-seller-id: <seller_id>' \
|
|
44
|
+
-H 'Content-Type: application/json' \
|
|
45
|
+
-d '{
|
|
46
|
+
"items": [{ "id": "ordli_01HXYZABCDEF", "quantity": 1 }],
|
|
47
|
+
"requires_shipping": true,
|
|
48
|
+
"location_id": "sloc_01HXYZABCDEF"
|
|
49
|
+
}'
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```ts JS Client
|
|
53
|
+
const { fulfillment } = await client.vendor.orders.$id.fulfillments.mutate({
|
|
54
|
+
$id: "order_01HXYZABCDEF",
|
|
55
|
+
items: [{ id: "ordli_01HXYZABCDEF", quantity: 1 }],
|
|
56
|
+
requires_shipping: true,
|
|
57
|
+
location_id: "sloc_01HXYZABCDEF",
|
|
58
|
+
})
|
|
59
|
+
```
|
|
60
|
+
</RequestExample>
|
|
61
|
+
|
|
62
|
+
<ResponseExample>
|
|
63
|
+
```json 200
|
|
64
|
+
{
|
|
65
|
+
"fulfillment": {
|
|
66
|
+
"id": "ful_01HXYZABCDEF",
|
|
67
|
+
"location_id": "sloc_01HXYZABCDEF",
|
|
68
|
+
"requires_shipping": true,
|
|
69
|
+
"packed_at": "2026-06-03T10:00:00.000Z",
|
|
70
|
+
"shipped_at": null,
|
|
71
|
+
"delivered_at": null,
|
|
72
|
+
"created_at": "2026-06-03T10:00:00.000Z"
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
</ResponseExample>
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Create Shipment"
|
|
3
|
+
api: "POST /vendor/orders/{id}/fulfillments/{fulfillment_id}/shipments"
|
|
4
|
+
description: "Create a shipment for a fulfillment."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Marks the fulfillment as shipped with optional tracking labels and returns the updated order.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
12
|
+
<ParamField path="fulfillment_id" type="string" required>The fulfillment's ID.</ParamField>
|
|
13
|
+
|
|
14
|
+
## Query parameters
|
|
15
|
+
|
|
16
|
+
<ParamField query="fields" type="string">Comma-separated list of fields to include in the returned order, prefix with `+`/`-` to add or remove from defaults.</ParamField>
|
|
17
|
+
|
|
18
|
+
## Body parameters
|
|
19
|
+
|
|
20
|
+
<ParamField body="items" type="object[]" required>
|
|
21
|
+
Items included in the shipment.
|
|
22
|
+
<Expandable title="properties">
|
|
23
|
+
<ParamField body="id" type="string" required>Line item ID.</ParamField>
|
|
24
|
+
<ParamField body="quantity" type="number" required>Quantity shipped.</ParamField>
|
|
25
|
+
</Expandable>
|
|
26
|
+
</ParamField>
|
|
27
|
+
<ParamField body="labels" type="object[]">
|
|
28
|
+
Tracking labels for the shipment.
|
|
29
|
+
<Expandable title="properties">
|
|
30
|
+
<ParamField body="tracking_number" type="string" required>The shipment's tracking number.</ParamField>
|
|
31
|
+
<ParamField body="tracking_url" type="string" required>URL to track the shipment.</ParamField>
|
|
32
|
+
<ParamField body="label_url" type="string" required>URL of the shipping label.</ParamField>
|
|
33
|
+
</Expandable>
|
|
34
|
+
</ParamField>
|
|
35
|
+
|
|
36
|
+
## Response
|
|
37
|
+
|
|
38
|
+
<ResponseField name="order" type="object">
|
|
39
|
+
<Expandable title="properties">
|
|
40
|
+
<ResponseField name="id" type="string">The order's ID.</ResponseField>
|
|
41
|
+
<ResponseField name="status" type="string">The order's status.</ResponseField>
|
|
42
|
+
<ResponseField name="fulfillments" type="object[]">The order's fulfillments with `shipped_at` set.</ResponseField>
|
|
43
|
+
<ResponseField name="items" type="object[]">The order's line items.</ResponseField>
|
|
44
|
+
</Expandable>
|
|
45
|
+
</ResponseField>
|
|
46
|
+
|
|
47
|
+
<RequestExample>
|
|
48
|
+
```bash cURL
|
|
49
|
+
curl -X POST 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/fulfillments/ful_01HXYZABCDEF/shipments' \
|
|
50
|
+
-H 'Authorization: Bearer <token>' \
|
|
51
|
+
-H 'x-seller-id: <seller_id>' \
|
|
52
|
+
-H 'Content-Type: application/json' \
|
|
53
|
+
-d '{
|
|
54
|
+
"items": [{ "id": "ordli_01HXYZABCDEF", "quantity": 1 }],
|
|
55
|
+
"labels": [
|
|
56
|
+
{
|
|
57
|
+
"tracking_number": "1Z999AA10123456784",
|
|
58
|
+
"tracking_url": "https://track.example.com/1Z999AA10123456784",
|
|
59
|
+
"label_url": "https://labels.example.com/1Z999AA10123456784.pdf"
|
|
60
|
+
}
|
|
61
|
+
]
|
|
62
|
+
}'
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
```ts JS Client
|
|
66
|
+
const { order } =
|
|
67
|
+
await client.vendor.orders.$id.fulfillments.$fulfillment_id.shipments.mutate({
|
|
68
|
+
$id: "order_01HXYZABCDEF",
|
|
69
|
+
$fulfillment_id: "ful_01HXYZABCDEF",
|
|
70
|
+
items: [{ id: "ordli_01HXYZABCDEF", quantity: 1 }],
|
|
71
|
+
labels: [
|
|
72
|
+
{
|
|
73
|
+
tracking_number: "1Z999AA10123456784",
|
|
74
|
+
tracking_url: "https://track.example.com/1Z999AA10123456784",
|
|
75
|
+
label_url: "https://labels.example.com/1Z999AA10123456784.pdf",
|
|
76
|
+
},
|
|
77
|
+
],
|
|
78
|
+
})
|
|
79
|
+
```
|
|
80
|
+
</RequestExample>
|
|
81
|
+
|
|
82
|
+
<ResponseExample>
|
|
83
|
+
```json 200
|
|
84
|
+
{
|
|
85
|
+
"order": {
|
|
86
|
+
"id": "order_01HXYZABCDEF",
|
|
87
|
+
"display_id": 42,
|
|
88
|
+
"status": "pending",
|
|
89
|
+
"fulfillments": [
|
|
90
|
+
{
|
|
91
|
+
"id": "ful_01HXYZABCDEF",
|
|
92
|
+
"shipped_at": "2026-06-04T10:00:00.000Z",
|
|
93
|
+
"delivered_at": null
|
|
94
|
+
}
|
|
95
|
+
]
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
</ResponseExample>
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Get Order Commission Lines"
|
|
3
|
+
api: "GET /vendor/orders/{id}/commission-lines"
|
|
4
|
+
description: "Retrieve the commission lines charged on the order."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Returns the marketplace commission lines applied to the order's items and shipping methods for the authenticated seller.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
12
|
+
|
|
13
|
+
## Response
|
|
14
|
+
|
|
15
|
+
<ResponseField name="commission_lines" type="object[]">
|
|
16
|
+
<Expandable title="properties">
|
|
17
|
+
<ResponseField name="id" type="string">The commission line's ID.</ResponseField>
|
|
18
|
+
<ResponseField name="item_id" type="string">ID of the line item the commission applies to, if any.</ResponseField>
|
|
19
|
+
<ResponseField name="shipping_method_id" type="string">ID of the shipping method the commission applies to, if any.</ResponseField>
|
|
20
|
+
<ResponseField name="commission_rate_id" type="string">ID of the commission rate that produced the line.</ResponseField>
|
|
21
|
+
<ResponseField name="code" type="string">Code of the applied commission rule.</ResponseField>
|
|
22
|
+
<ResponseField name="rate" type="number">The commission rate applied.</ResponseField>
|
|
23
|
+
<ResponseField name="amount" type="number">The commission amount charged.</ResponseField>
|
|
24
|
+
<ResponseField name="description" type="string">Description of the commission line.</ResponseField>
|
|
25
|
+
<ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
|
|
26
|
+
<ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
|
|
27
|
+
</Expandable>
|
|
28
|
+
</ResponseField>
|
|
29
|
+
<ResponseField name="count" type="number">Number of commission lines returned.</ResponseField>
|
|
30
|
+
|
|
31
|
+
<RequestExample>
|
|
32
|
+
```bash cURL
|
|
33
|
+
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/commission-lines' \
|
|
34
|
+
-H 'Authorization: Bearer <token>' \
|
|
35
|
+
-H 'x-seller-id: <seller_id>'
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
```ts JS Client
|
|
39
|
+
const { commission_lines, count } =
|
|
40
|
+
await client.vendor.orders.$id.commissionLines.query({
|
|
41
|
+
$id: "order_01HXYZABCDEF",
|
|
42
|
+
})
|
|
43
|
+
```
|
|
44
|
+
</RequestExample>
|
|
45
|
+
|
|
46
|
+
<ResponseExample>
|
|
47
|
+
```json 200
|
|
48
|
+
{
|
|
49
|
+
"commission_lines": [
|
|
50
|
+
{
|
|
51
|
+
"id": "comline_01HXYZABCDEF",
|
|
52
|
+
"item_id": "ordli_01HXYZABCDEF",
|
|
53
|
+
"shipping_method_id": null,
|
|
54
|
+
"commission_rate_id": "comrate_01HXYZABCDEF",
|
|
55
|
+
"code": "default",
|
|
56
|
+
"rate": 10,
|
|
57
|
+
"amount": 250,
|
|
58
|
+
"description": null,
|
|
59
|
+
"created_at": "2026-06-01T10:00:00.000Z",
|
|
60
|
+
"updated_at": "2026-06-01T10:00:00.000Z"
|
|
61
|
+
}
|
|
62
|
+
],
|
|
63
|
+
"count": 1
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
</ResponseExample>
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "List Order Changes"
|
|
3
|
+
api: "GET /vendor/orders/{id}/changes"
|
|
4
|
+
description: "Retrieve the change history of an order."
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Returns all order changes (edits, returns, exchanges, claims) recorded for the order, with their actions.
|
|
8
|
+
|
|
9
|
+
## Path parameters
|
|
10
|
+
|
|
11
|
+
<ParamField path="id" type="string" required>The order's ID.</ParamField>
|
|
12
|
+
|
|
13
|
+
## Query parameters
|
|
14
|
+
|
|
15
|
+
<ParamField query="fields" type="string">Comma-separated list of fields to include, prefix with `+`/`-` to add or remove from defaults.</ParamField>
|
|
16
|
+
|
|
17
|
+
## Response
|
|
18
|
+
|
|
19
|
+
<ResponseField name="order_changes" type="object[]">
|
|
20
|
+
<Expandable title="properties">
|
|
21
|
+
<ResponseField name="id" type="string">The order change's ID.</ResponseField>
|
|
22
|
+
<ResponseField name="order_id" type="string">ID of the order the change belongs to.</ResponseField>
|
|
23
|
+
<ResponseField name="version" type="number">Order version the change targets.</ResponseField>
|
|
24
|
+
<ResponseField name="change_type" type="string">Type of change, e.g. `edit`, `return`, `exchange`, `claim`.</ResponseField>
|
|
25
|
+
<ResponseField name="status" type="string">The change's status, e.g. `pending`, `confirmed`, `canceled`.</ResponseField>
|
|
26
|
+
<ResponseField name="created_by" type="string">ID of the actor who created the change.</ResponseField>
|
|
27
|
+
<ResponseField name="confirmed_by" type="string">ID of the actor who confirmed the change.</ResponseField>
|
|
28
|
+
<ResponseField name="canceled_by" type="string">ID of the actor who canceled the change.</ResponseField>
|
|
29
|
+
<ResponseField name="actions" type="object[]">The individual actions that make up the change.</ResponseField>
|
|
30
|
+
<ResponseField name="created_at" type="string">Creation timestamp.</ResponseField>
|
|
31
|
+
<ResponseField name="updated_at" type="string">Last update timestamp.</ResponseField>
|
|
32
|
+
<ResponseField name="confirmed_at" type="string">Confirmation timestamp.</ResponseField>
|
|
33
|
+
<ResponseField name="canceled_at" type="string">Cancellation timestamp.</ResponseField>
|
|
34
|
+
</Expandable>
|
|
35
|
+
</ResponseField>
|
|
36
|
+
|
|
37
|
+
<RequestExample>
|
|
38
|
+
```bash cURL
|
|
39
|
+
curl 'http://localhost:9000/vendor/orders/order_01HXYZABCDEF/changes' \
|
|
40
|
+
-H 'Authorization: Bearer <token>' \
|
|
41
|
+
-H 'x-seller-id: <seller_id>'
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
```ts JS Client
|
|
45
|
+
const { order_changes } = await client.vendor.orders.$id.changes.query({
|
|
46
|
+
$id: "order_01HXYZABCDEF",
|
|
47
|
+
})
|
|
48
|
+
```
|
|
49
|
+
</RequestExample>
|
|
50
|
+
|
|
51
|
+
<ResponseExample>
|
|
52
|
+
```json 200
|
|
53
|
+
{
|
|
54
|
+
"order_changes": [
|
|
55
|
+
{
|
|
56
|
+
"id": "ordch_01HXYZABCDEF",
|
|
57
|
+
"order_id": "order_01HXYZABCDEF",
|
|
58
|
+
"version": 2,
|
|
59
|
+
"change_type": "return",
|
|
60
|
+
"status": "confirmed",
|
|
61
|
+
"created_by": "sel_01HXYZABCDEF",
|
|
62
|
+
"actions": [
|
|
63
|
+
{
|
|
64
|
+
"id": "ordchact_01HXYZABCDEF",
|
|
65
|
+
"action": "RETURN_ITEM",
|
|
66
|
+
"details": { "quantity": 1 }
|
|
67
|
+
}
|
|
68
|
+
],
|
|
69
|
+
"created_at": "2026-06-02T10:00:00.000Z",
|
|
70
|
+
"confirmed_at": "2026-06-02T11:00:00.000Z"
|
|
71
|
+
}
|
|
72
|
+
]
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
</ResponseExample>
|