Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostOrdersOrderClaimsClaimReq.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

3.9 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminPostOrdersOrderClaimsClaimReq

internal.internal.AdminPostOrdersOrderClaimsClaimReq

Schema

AdminPostOrdersOrderClaimsClaimReq type: object properties: claim_items: description: The Claim Items that the Claim will consist of. type: array items: type: object required: - id - images - tags properties: id: description: The ID of the Claim Item. type: string item_id: description: The ID of the Line Item that will be claimed. type: string quantity: description: The number of items that will be returned type: integer note: description: Short text describing the Claim Item in further detail. type: string reason: description: The reason for the Claim type: string enum: - missing_item - wrong_item - production_failure - other tags: description: A list o tags to add to the Claim Item type: array items: type: object properties: id: type: string description: Tag ID value: type: string description: Tag value images: description: A list of image URL's that will be associated with the Claim type: array items: type: object properties: id: type: string description: Image ID url: type: string description: Image URL metadata: description: An optional set of key-value pairs to hold additional information. type: object externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" shipping_methods: description: The Shipping Methods to send the additional Line Items with. type: array items: type: object properties: id: description: The ID of an existing Shipping Method type: string option_id: description: The ID of the Shipping Option to create a Shipping Method from type: string price: description: The price to charge for the Shipping Method type: integer data: description: An optional set of key-value pairs to hold additional information. type: object no_notification: description: If set to true no notification will be send related to this Swap. type: boolean metadata: description: An optional set of key-value pairs to hold additional information. type: object externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"

Properties

claim_items

Optional claim_items: Item[]

Defined in

packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:164


metadata

Optional metadata: Record<string, unknown>

Defined in

packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:167


no_notification

Optional no_notification: boolean

Defined in

packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:166


shipping_methods

Optional shipping_methods: ShippingMethod[]

Defined in

packages/medusa/dist/api/routes/admin/orders/update-claim.d.ts:165