Get Tickets¶
Retrieve tickets by ID¶
This endpoint allows the seller to retrieve a ticket using id as a reference.
Required scope
| Value | Description |
|---|---|
open:tickets-seller:read |
Allows read access to API resources. |
Request parameters
| Field | Type | Description | Required |
|---|---|---|---|
id |
string | Key to identify the ticket. | Yes |
Request:
curl -X 'GET' \
'https://api.magalu.com/seller/v0/tickets/{id}' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
| Field | Type | Description |
|---|---|---|
type |
String | Type of tickets. ENUM: cancellation,payment, shipping |
channel |
String | Channel to which the request belongs. |
channel.id |
String | Unique order identifier on the platform. |
channel.alias |
String | The channel alias. |
order |
String | Details of the items for which the protocol is being opened. |
order.id |
String | Unique order identifier on the platform. |
order.code |
String | Order code. |
order.delivery |
Object | Details of the items that will be part of the request. |
order.delivery.id |
String | Unique order identifier on the platform. |
order.delivery.seller |
String | Information about the seller who made the sale. |
order.delivery.items |
List | Items that make up the protocol. |
order.delivery.seller.id |
String | Tenant Seller ID on Id Magalu. |
order.delivery.seller.name |
String | Seller or Store Name. |
order.delivery.items.id |
String | Unique order identifier on the platform. |
order.delivery.items.sku |
String | SKU identifier in the system. |
order.delivery.items.external_sku |
String | SKU identifier in the external system (integrator or seller). |
order.delivery.items.name |
String | Product name. |
order.delivery.items.description |
String | Product Description. |
order.delivery.items.image |
String | Main product image. |
order.delivery.items.quantity |
String | Number of items linked to the protocol. |
reason |
String | Code that represents the reason for opening the ticket. Can be the following values: shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, general, payment_authorization_failure, payment_discrepancy. |
Response:
{
"created_at": "2024-08-07T13:42:45",
"updated_at": "2024-08-07T13:42:46",
"id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
"code": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
"type": "payment",
"channel": {
"id": "3f042852-3efc-4d47-97f8-f94989c7b0bc",
"alias": "marketplace"
},
"order": {
"id": "bcc662e8-527b-410f-87a5-bbc8f5e623da",
"code": "1281270182459143",
"delivery": {
"id": "96061b77-b065-4cd8-9e41-b097bf95c173",
"seller": {
"id": "c85be697-7b14-4460-a5c7-3e58b4a364f9",
"name": "SellerName"
},
"items": [
{
"description": "Livro infantil a Bela e a Fera com encartes em 3D.",
"external_sku": "livro-seller-01",
"id": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157",
"image": "https://imagem.do.livro/foto.jpg",
"name": "A Bela e a Fera em 3D",
"quantity": 1,
"sku": "livro-01"
}
]
}
},
"status": "waiting",
"closed": false,
"reason": null,
"protocol": "202301000001123",
"due_date": "2024-08-09T13:42:46",
"origin": "customer"
}
Return codes
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Retrieve tickets by filters¶
This endpoint allows the seller to retrieve a collection of tickets using filters as a reference.
Required scope
| Value | Description |
|---|---|
open:tickets-seller:read |
Allows read access to API resources. |
Request parameters
| Field | Type | Description | Required |
|---|---|---|---|
_offset |
Number | Reference record position. The next N records will be returned from it. Default value 0. | No |
_limit |
Number | Determines the number of records to be returned. Default value 10. | No |
status |
String | Ticket status. Can be the following values: waiting_seller, waiting_customer, waiting_marketplace, waiting_return_info, waiting_item_return, waiting_rating, waiting_banking_account, waiting_customer_complement, waiting_rating_complement, waiting_customer_close_ticket, refund_authorized, validating_bank_account, refund_denied, waiting_seller_pickup, seller_already_pickedup, waiting_picked_up, closed, waiting_partner_receive_collected_product, reversal_made, waiting_pickup, waiting_checklist, waiting_pickup_schedule, waiting_to_complete_the_checklist, failed_to_identify_reverse, validating_return_invoice, valid_return_invoice, waiting_refund_release, waiting_confirmation_collection_schedule, failed_collection_schedule. |
No |
reason |
String | Code that represents the reason for opening the ticket. Can be the following values: shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, shipping_delay, price_discrepancy, incorrect_product, missing_damaged_parts, duplicated_order, payment_issue, quality_concern, change_of_mind, unavailability, customer_error, unexpected_circumstances, shipping_address_issues, general, payment_authorization_failure, payment_discrepancy |
No |
channel__id |
String | Unique channel identifier. | No |
channel__alias |
String | The alias that belongs to the channel. | No |
ticket_id |
String | Ticket UUID identifier. | No |
order__id |
String | Order UUID identifier. | No |
order__code |
String | Order identifier. | Não |
ticket_id |
String | Ticket UUID identifier. | No |
protocol |
String | Ticket's protocol identifier. | Não |
created_at_gte |
String (datetime - ISO 8601) | Filters all tickets with a greater than or equal creation date. | No |
created_at_lte |
String (datetime - ISO 8601) | Filters all tickets with a less than or equal creation date. | No |
Request:
curl -X 'GET' \
'https://api.magalu.com/seller/v0/tickets' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
Response:
{
"meta": {
"page": {
"limit": 1,
"offset": 1,
"count": 1,
"max_limit": 10
},
"links": {
"previous": "?_offset=0&_limit=1",
"self": "?_offset=1&_limit=1",
"next": "?_offset=2&_limit=1"
}
},
"results": [
{
"created_at": "2024-08-07T13:42:45",
"updated_at": "2024-08-07T13:42:46",
"id": "80b31c59-6d31-4d93-982a-7a6f51e335f5",
"code": "f148ae87-0ce9-435b-94a4-6aa572f0569a",
"type": "cancellation",
"channel": {
"id": "3f042852-3efc-4d47-97f8-f94989c7b0bc",
"alias": "marketplace"
},
"order": {
"id": "bcc662e8-527b-410f-87a5-bbc8f5e623da",
"code": "1281270182459143",
"delivery": {
"id": "96061b77-b065-4cd8-9e41-b097bf95c173",
"seller": {
"id": "c85be697-7b14-4460-a5c7-3e58b4a364f9",
"name": "SellerName"
},
"items": [
{
"description": "Livro infantil a Bela e a Fera com encartes em 3D.",
"external_sku": "livro-seller-01",
"id": "63c54b4a-ea19-4c52-90a8-bd38cd1a3157",
"image": "https://imagem.do.livro/foto.jpg",
"name": "A Bela e a Fera em 3D",
"quantity": 1,
"sku": "livro-01"
}
]
}
},
"status": "waiting",
"closed": "payment_issue",
"reason": "payment_issue",
"protocol": "2024080713422397",
"due_date": "2024-08-09T13:42:46",
"origin": "channel"
}
]
}
Return code
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Internal Server Error |