Articles in this section

Available Loop Returns APIs

Naga Sri Hari Gonaboyina
Updated

When you configure an export, import, or other type of flow step using the prebuilt Loop Returns connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Loop Returns API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Allowlist List allowlist items X
Create allowlist item X
Get allowlist item X
Delete allowlist item X
Blocklist List blocklist items X
Create blocklist items X
Get blocklist item X
Delete blocklist item X
Cart Get cart X
Create a cart X
Update cart X
Delete cart X
Destinations Get all destinations X
Create destination X
Destination details X
Update destination X
Delete destination X
Dispositions Assess dispositions X
Fraud reports Create fraud report X
Happy returns shipments Get shipment information X
List shipments X
Get shipment items X
Items grading and dispositioning Grade items X
Label requests List label requests X
Get label request X
Create a label request error X
Create label X
Update label status X
Listings List blocklist items X
Get blocklisted items X
List allowlisted items X
Get allowlist item X
Add blocklist item X
Delete blacklist entry X
Add allowlist item X
Delete allowlist entry X
Orders Create return deep link X
Programmatic webhooks Get webhooks X
Create webhook X
Delete webhook X
Update webhook X
Return actions Advanced shipping notice X
Detailed returns list X
Get return details X
Get return notes X
Process return X
Flag return X
Cancel return X
Create return note X
Remove line items X
Close return X
Create return deep link with QR code X
Return data Detailed returns list (Deprecated) X
Return details X

Available DI objects

The following objects are available when using Loop Returns as a source in Celigo Data Integration (DI).

Primary key: All Loop Returns DI endpoints use id as the primary key, except the shipment tracking endpoint which uses loop_shipment_id. Loop assigns a numeric id to each resource object.

Note

Loop Returns soft deletes records. Returns are cancelled, closed, or rejected through lifecycle state transitions rather than physically removed, and remain retrievable via the API. Celigo syncs all data returned by the source as-is.

Object API endpoint Available extract modes Delta field
Allowlist List allowlist items Full —
Blocklist List blocklist items Full —
Destinations Get all destinations Full —
Happy returns shipments List shipments Full, Incremental from
Label requests List label requests Full, Incremental from
Listings API List blocklist items Full —
Return actions Detailed returns list Full, Incremental from

Response schemas

Click an object below to view its response fields and delta configuration.

Allowlist — List allowlist items

Response schema:

Field Type
id number (Primary key)
type string
value string
secondary_value string
created_at string
Blocklist — List blocklist items

Response schema:

Field Type
id number (Primary key)
type string
value string
secondary_value string
created_at string
Destinations — Get all destinations

Response schema:

Field Type
id number (Primary key)
type string
name string
enabled boolean
provider_location_id number
address object
address.name string
address.company string
address.address1 string
address.address2 string
address.city string
address.state string
address.zip string
address.country string
address.country_code string
Happy returns shipments — List shipments

Delta configuration: use it to request incremental data.

Setting Value
Delta filter from = {{{encodeURI lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
loop_shipment_id number (Primary key)
happy_returns_shipment_id string
line_item_count number
return_count number
created_at string
updated_at string
Label requests — List label requests

Delta configuration: use it to request incremental data.

Setting Value
Delta filter from = {{{encodeURI lastExportDateTime}}}
Date format YYYY-MM-DDTHH:mm:ss[Z]

Response schema:

Field Type
id string (Primary key)
addresses object
addresses.origin object
addresses.origin.name string
addresses.origin.company string
addresses.origin.address1 string
addresses.origin.address2 string
addresses.origin.city string
addresses.origin.state string
addresses.origin.zip string
addresses.origin.country string
addresses.origin.country_code string
addresses.origin.phone string
addresses.destination object
addresses.destination.name string
addresses.destination.company string
addresses.destination.address1 string
addresses.destination.address2 string
addresses.destination.city string
addresses.destination.state string
addresses.destination.zip string
addresses.destination.country string
addresses.destination.country_code string
addresses.destination.phone string
parcel object
parcel.height number
parcel.length number
parcel.width number
parcel.weight number
products objectarray
products.name string
products.price object
products.price.amount number
products.price.currency string
products.country_of_origin string
products.hs_code string
products.sku string
errors objectarray
errors.reason string
errors.message string
errors.created_at string
return_id number
shop_id number
status string
created_at string
Listings API — List blocklist items

Response schema:

Field Type
id number (Primary key)
type string
value string
secondary_value string
created_at string
Return actions — Detailed returns list

Delta configuration: use it to request incremental data.

Setting Value
Delta filter from = {{{encodeURI lastExportDateTime}}}
Additional parameters filter = updated_at
Date format YYYY-MM-DD HH:mm:ss

Response schema:

Field Type
id string (Primary key)
state string
created_at string
updated_at string
edited_at string
total string
outcome string
order_id string
order_name string
provider_order_id string
order_number string
provider_order_number string
customer string
origin_country string
origin_country_code string
multi_currency boolean
currency string
return_product_total string
return_discount_total string
return_tax_total string
return_total string
refund_shipping_total string
refund_shipping_tax_total string
return_credit_total string
exchange_product_total string
exchange_discount_total string
exchange_tax_total string
exchange_total string
exchange_credit_total string
gift_card string
gift_card_order_name string
gift_card_order_id string
handling_fee string
refund string
upsell string
line_items objectarray
line_items.line_item_id string
line_items.provider_line_item_id string
line_items.product_id string
line_items.variant_id string
line_items.sku string
line_items.title string
line_items.price string
line_items.discount string
line_items.tax string
line_items.refund string
line_items.refund_item string
line_items.refund_tax string
line_items.refund_shipping string
line_items.refund_excluding_shipping string
line_items.refund_shipping_tax string
line_items.refund_excluding_shipping_tax string
line_items.returned_at string
line_items.exchange_variant string
line_items.return_reason string
line_items.parent_return_reason string
line_items.return_comment string
line_items.barcode string
line_items.outcome string
line_items.provider_restock_location_id string
line_items.consolidation_tracking string
line_items.consolidation_destination_id string
line_items.condition object
line_items.condition.description string
line_items.condition.condition_category string
line_items.condition.return_processor string
line_items.condition.note string
line_items.condition.inspected_at string
line_items.condition.images stringarray
line_items.disposition object
line_items.disposition.disposition_outcome string
line_items.disposition.return_processor string
line_items.disposition.note string
line_items.disposition.inspected_at string
exchanges objectarray
exchanges.exchange_id string
exchanges.exchange_order_id number
exchanges.exchange_order_name string
exchanges.product_id string
exchanges.variant_id string
exchanges.sku string
exchanges.type string
exchanges.title string
exchanges.price string
exchanges.discount string
exchanges.tax string
exchanges.total string
exchanges.out_of_stock boolean
exchanges.out_of_stock_resolution string
exchanges.consolidation_tracking string
carrier string
tracking_number string
label_status string
label_url string
label_rate string
status_page_url string
label_updated_at string
destination_id string
return_method object
return_method.provider string
return_method.method_type string
return_method.address object
return_method.address.id number
return_method.address.hash string
return_method.address.created_at string
return_method.address.updated_at string
return_method.address.name string
return_method.address.company string
return_method.address.address1 string
return_method.address.address2 string
return_method.address.city string
return_method.address.state string
return_method.address.zip string
return_method.address.country string
return_method.address.country_code string
return_method.address.phone string
return_method.address.latitude number
return_method.address.longitude number
return_method.state string
return_method.rma_id string
return_method.qr_code_url string
return_method.updated_at object
return_method.updated_at.date string
return_method.updated_at.timezone_type number
return_method.updated_at.timezone string
return_method.scheduled_at string
return_method.scannable_id string
package_reference string
type string
labels objectarray
labels.status string
labels.updated_at string
labels.url string
labels.rate number
labels.carrier string
labels.tracking_number string
labels.line_items numberarray