Skip to content

Create Return Codes

Create return codes for a ticket

This endpoint allows you to create a return code for a given ticket

Required scope

Value Description
open:ticket-messages-seller:write Allows the use of write/update APIs.

Request parameters

Field Type Description Required
ticket_uuid string Key to identify the ticket. Yes

Request:

curl -X 'POST' \
  'https://api.magalu.com/seller/v0/tickets/{ticket_uuid}/returns' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \
Response parameters

Field Type Description
transaction_id String A unique identifier to track transaction status.
links List A list with the endpoint to retrieve the transaction status.

Response:

{
  "transaction_id": "2d97892b-50f2-4e0e-8967-3d962c29ade9",
  "links": [
    {
      "path": "/seller/v0/transactions/2d97892b-50f2-4e0e-8967-3d962c29ade9"
    }
  ]
}

Return codes

Code Description
202 Accepted
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Track Return Code Creation Completion

Return code creation is an asynchronous process and can be tracked via transactions. See the documentation on asynchronous responses and transactions for more information on this process.