POST v3/returnMerchandiseAuthorizations

POST 
/v3/returnMerchandiseAuthorizations

Announce that a customer will return products from a shipment.

This endpoint allows the registration of the intent to return a quantity of products related to shipment. Each returnMerchandiseAuthorizationItem must be associated to a shipmentItem that delivered the products to the consumer. This association is expressable through the relationships object under the returnMerchandiseAuthorizationItem.

Validation

The request is rejected when:

• the referenced shipment does not exist;
• the requested quantity is lower than 1;
• the requested quantity exceeds the quantity originally shipped, optionally minus quantities already authorized or returned;
• the referenced returnReason does not exist or is not available for the API user;
• duplicate returnMerchandiseAuthorizationItem lines are submitted for the same shipmentItem unless explicitly allowed.

Request

Responses

201

Created

401

401 Unauthorized

A 401 Unauthorized response occurs when attempting to access a resource or perform an action that requires authentication, but no valid credentials have been provided. It indicates that the requester is unauthorized to access the requested resource.

The following are common scenarios that may lead to a 401 Unauthorized response:

• Attempting to access a protected API endpoint without providing authentication credentials.
• Providing an invalid or expired authentication token.
• Providing valid authentication credentials, but lacking sufficient privileges to access the requested resource.
• Providing authentication credentials that are valid for a different resource or API endpoint than the one being requested.

403

403 Forbidden

The HTTP 403 Forbidden client error response status code indicates that the server understood the request but refused to process it. This status is similar to 401 Unauthorized, except that for 403 Forbidden responses, authenticating or re-authenticating makes no difference. The request failure is tied to application logic, such as insufficient permissions to a resource or action.

406

406 Not Acceptable

A 406 Not Acceptable response occurs when the server cannot provide a response that matches the client's requested format or content language for the requested resource. For instance, if a client sends an Accept header of text/html to an API endpoint that only supports application/json responses, the server would respond with a 406 Not Acceptable status code. This type of response is a required response for JSON:API compatible endpoints.

409

409 Conflict

A 409 Conflict response occurs when attempting to perform an action that conflicts with the current state of a resource on the server. It indicates that the requested action cannot be completed due to a conflict between the provided information and the current state of the resource.

415

415 Unsupported Media Type

A 415 Unsupported Media Type response occurs when the server cannot process the request because the media type specified in the request is not supported for the requested resource. For example, if a client sends a request with a Content-Type header of application/pdf to an API endpoint that only supports application/json (the only valid media type for JSON:API), the server would respond with a 415 Unsupported Media Type status code. This type of error-response is a required for JSON:API compatible endpoints.