Returns > Returns > returnsApprove
Commerce APIReturnsReturnsreturnsApprove
returnsApprove
POST:returns/approve.json

Description

Approve a return. It will mark fulfillment items are returned.

Permission bit: "returns.modify"

Topic: Returns

Arguments

data: ReturnApprove!

Main argument for mutations.


return_id: String!

Unique return identifier. See also: Unique Identifiers

Example: "rt_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

label_file_id: String

Label file ID

Example: "fi_EQzGqWoY"

Valid when: label_file_id matches regexp pattern: ^fi_|^fc_


shipping_provider_type: ShippingProviderType

Type of the shipping provider


tracking_company: String

The name of the shipping company

Example: "Ship & Co"

Valid when: tracking_company's length doesn't exceed 250 characters


tracking_number: String

Shipping number, provided by the shipping company

Example: "1Z2345"

Valid when: tracking_number's length doesn't exceed 250 characters


tracking_url: String

The URLs to track the fulfillment

Example: "http://www.google.com/search?q=1Z2345"

Valid when: tracking_url's length doesn't exceed 250 characters


Result

Return

Preview (typescript)

Loading module