Retrieve the status of a return

GET {{baseUrl}}/brand/:brand_domain/return-portal/label/polling?token=<string>

Once a return parcel is successfully created, a polling URL is included in the response. Creating a label depends on the response time of the carrier, so you need to make a request to this endpoint to see the status of the label. The URL you received contains a token with the id, so you don’t need to provide any additional lookup details or authentication.

• A 200 response will indicate that the label is ready and can be downloaded.
  
• A 202 response will indicate that the label is not ready to be downloaded but the return data has been accepted. If you have paid returns enabled this status is used to indicate we are waiting for payment. For more information take a look at this help center article.
• A 500 response means that the label announcement failed.

Request Params

HEADERS

RESPONSES

status: OK

{"download_url":"\u003curi\u003e","return":"\u003cinteger\u003e","parcels":["\u003cinteger\u003e","\u003cinteger\u003e"],"tracking_numbers":["\u003cstring\u003e","\u003cstring\u003e"],"customs_declaration_url":"\u003curi\u003e"}