returns - Magento B2B API

Save RMA

curl --location -g --request POST 'http:///V1/returns' \ --header 'Content-Type: application/json' \ --data-raw '{ "rmaDataObject": { "comments": [ { "admin": true, "comment": "string", "created_at": "string", "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "customer_notified": true, "entity_id": 0, "extension_attributes": {}, "rma_entity_id": 0, "status": "string", "visible_on_front": true } ], "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "customer_custom_email": "string", "customer_id": 0, "date_requested": "string", "entity_id": 0, "extension_attributes": {}, "increment_id": "string", "items": [ { "condition": "string", "entity_id": 0, "extension_attributes": {}, "order_item_id": 0, "qty_approved": 0, "qty_authorized": 0, "qty_requested": 0, "qty_returned": 0, "reason": "string", "resolution": "string", "rma_entity_id": 0, "status": "string" } ], "order_id": 0, "order_increment_id": "string", "status": "string", "store_id": 0, "tracks": [ { "carrier_code": "string", "carrier_title": "string", "entity_id": 0, "extension_attributes": {}, "rma_entity_id": 0, "track_number": "string" } ] } }'

{ "comments": [ { "admin": true, "comment": "string", "created_at": "string", "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "customer_notified": true, "entity_id": 0, "extension_attributes": {}, "rma_entity_id": 0, "status": "string", "visible_on_front": true } ], "custom_attributes": [ { "attribute_code": "string", "value": "string" } ], "customer_custom_email": "string", "customer_id": 0, "date_requested": "string", "entity_id": 0, "extension_attributes": {}, "increment_id": "string", "items": [ { "condition": "string", "entity_id": 0, "extension_attributes": {}, "order_item_id": 0, "qty_approved": 0, "qty_authorized": 0, "qty_requested": 0, "qty_returned": 0, "reason": "string", "resolution": "string", "rma_entity_id": 0, "status": "string" } ], "order_id": 0, "order_increment_id": "string", "status": "string", "store_id": 0, "tracks": [ { "carrier_code": "string", "carrier_title": "string", "entity_id": 0, "extension_attributes": {}, "rma_entity_id": 0, "track_number": "string" } ] }

请求参数

Body 参数application/json

rmaDataObject

object (rma-data-rma-interface)

必需

Interface RmaInterface

comments

array[object (rma-data-comment-interface) {10}]

必需

Comments list

custom_attributes

array[object (framework-attribute-interface) {2}]

可选

Custom attributes values.

customer_custom_email

string

必需

Customer_custom_email

customer_id

integer

必需

Customer_id

date_requested

string

必需

Date_requested

entity_id

integer

Entity_id

必需

extension_attributes

object (rma-data-rma-extension-interface)

可选

ExtensionInterface class for @see \Magento\Rma\Api\Data\RmaInterface

increment_id

string

Entity_id

必需

items

array[object (rma-data-item-interface) {12}]

Items

必需

order_id

integer

Order_id

必需

order_increment_id

string

必需

Order_increment_id

status

string

Status

必需

store_id

integer

Store_id

必需

tracks

array[object (rma-data-track-interface) {6}]

必需

Tracks list

示例

返回响应

🟢200成功

application/json

200 Success.

Body

Interface RmaInterface

comments

array[object (rma-data-comment-interface) {10}]

必需

Comments list

admin

boolean

Is_admin

必需

comment

string

Comment

必需

created_at

string

必需

Created_at

custom_attributes

array[object (framework-attribute-interface) {2}]

可选

Custom attributes values.

customer_notified

boolean

必需

Is_customer_notified

entity_id

integer

Entity_id

必需

extension_attributes

object (rma-data-comment-extension-interface)

可选

ExtensionInterface class for @see \Magento\Rma\Api\Data\CommentInterface

rma_entity_id

integer

Rma Id

必需

status

string

Status

必需

visible_on_front

boolean

必需

Is_visible_on_front

custom_attributes

array[object (framework-attribute-interface) {2}]

可选

Custom attributes values.

attribute_code

string

必需

Attribute code

value

string

必需

Attribute value

customer_custom_email

string

必需

Customer_custom_email

customer_id

integer

必需

Customer_id

date_requested

string

必需

Date_requested

entity_id

integer

Entity_id

必需

extension_attributes

object (rma-data-rma-extension-interface)

可选

ExtensionInterface class for @see \Magento\Rma\Api\Data\RmaInterface

increment_id

string

Entity_id

必需

items

array[object (rma-data-item-interface) {12}]

Items

必需

condition

string

Condition

必需

entity_id

integer

必需

extension_attributes

object (rma-data-item-extension-interface)

可选

ExtensionInterface class for @see \Magento\Rma\Api\Data\ItemInterface

order_item_id

integer

必需

Order_item_id

qty_approved

integer

必需

Qty_approved

qty_authorized

integer

必需

Qty_authorized

qty_requested

integer

必需

Qty_requested

qty_returned

integer

必需

Qty_returned

reason

string

Reason

必需

resolution

string

必需

Resolution

rma_entity_id

integer

RMA id

必需

status

string

Status

必需

order_id

integer

Order_id

必需

order_increment_id

string

必需

Order_increment_id

status

string

Status

必需

store_id

integer

Store_id

必需

tracks

array[object (rma-data-track-interface) {6}]

必需

Tracks list

carrier_code

string

必需

Carrier code

carrier_title

string

必需

Carrier title

entity_id

integer

Entity id

必需

extension_attributes

object (rma-data-track-extension-interface)

可选

ExtensionInterface class for @see \Magento\Rma\Api\Data\TrackInterface

rma_entity_id

integer

必需

Rma entity id

track_number

string

必需

Track number

🟠401没有权限

🔴500服务器错误