Create Label Request Error

Submit unrecoverable errors encountered when generating labels for merchants.

Required API key scope

• Label Requests (Write)

POST /label-requests/{id}/errors

Create Label Request Error

cURL

curl --request POST \
  --url https://api.loopreturns.com/api/v1/label-requests/{id}/errors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "INVALID_ADDRESS",
  "message": "Failed to generate a label, the origin address is invalid"
}
'

200

{
  "reason": "INVALID_ADDRESS",
  "message": "Failed to generate a label, the origin address is invalid",
  "created_at": "2023-04-25T13:25:00-05:00"
}

Authorizations

oauth2label-requests-write

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · integer · required

The unique identifier for the label request, created by Loop.

Example:

67329889100573

Body

application/json

reason · enum<string> · required

The reason code associated with the label request error.

Available options: INSUFFICIENT_FUNDS, INVALID_ADDRESS, Other

Example:

"INVALID_ADDRESS"

message · string

The message associated with the label request error.

Example:

"Failed to generate a label, the origin address is invalid"

Response

200

application/json

OK

reason · enum<string>

The reason code associated with the label request error.

Available options: INSUFFICIENT_FUNDS, INVALID_ADDRESS, Other

Example:

"INVALID_ADDRESS"

message · string

The message associated with the label request error.

Example:

"Failed to generate a label, the origin address is invalid"

created_at · string<date-time>

The date the label was created.

Example:

"2023-04-25T13:25:00-05:00"