curl --request POST \
--url https://api.loopreturns.com/api/{version}/ship-by-loop/shipments/{shipmentId}/errors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"errors": [
{
"message": "Carrier rejected the destination address",
"package_id": "385e1705-ca07-41ba-b62e-49ac9065f2a4"
}
]
}
'Report errors on a shipment
Report one or more problems the provider could not resolve on its own. Each error is scoped to a package, and may optionally be scoped further to a single item within that package.
Reporting an error is purely a record — it does not change the shipment’s state or the shopper-facing flow, and it does not block you from still calling /services or /orders for the same package afterward. Errors are not deduplicated, so retrying the same call records a duplicate entry each time.
Required OAuth scope
ship_by_loop:write
curl --request POST \
--url https://api.loopreturns.com/api/{version}/ship-by-loop/shipments/{shipmentId}/errors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"errors": [
{
"message": "Carrier rejected the destination address",
"package_id": "385e1705-ca07-41ba-b62e-49ac9065f2a4"
}
]
}
'Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The id of the Shipment
"ff8a4470-41e0-4cc3-9bfe-44564f4286b7"
Body
The same package_id may appear in more than one entry — for example, an item-level error and a separate package-level error on the same package.
1Show child attributes
Show child attributes
Response
The request was processed successfully