Advanced Shipping Notice

GET

warehouse

reporting

asn

curl --request GET \
  --url https://api.loopreturns.com/api/v1/warehouse/reporting/asn \
  --header 'X-Authorization: <api-key>'

[
  {
    "id": 17,
    "return_line_item_id": "36",
    "order_id": "2685651685584",
    "order_name": "#1138",
    "order_number": "138",
    "provider_order_number": "1138",
    "state": "open",
    "customer_email": "h.testman@loopreturns.com",
    "title": "Mens Large Hydrostatic Inflatable PFD",
    "purchase_price": "199.99",
    "sku": "ad-alias-corporis-cum-ut-facilis-sed-non",
    "barcode": "789765484987",
    "carrier": "USPS",
    "service": "Parcel Select",
    "label_status": "out_for_delivery",
    "tracking_number": "9999999999999999999999",
    "integration_tracking_url": "N/A",
    "restock_status": "restocked",
    "currency": "USD",
    "label_updated_at": "2023-08-21T14:09:17.000Z",
    "label_url": "https://test-bucket.s3-us-west-2.amazonaws.com/files/postage_label/01234567/0df7eea6147b44b7ac204e9eb8293cfa.pdf",
    "label_rate": "250",
    "closed_at": "2023-09-01T14:00:41.000Z",
    "updated_at": "2023-08-21T14:06:32.000Z",
    "created_at": "2023-08-21T14:05:56.000Z",
    "return_reason": "Size was too small",
    "actioned_by": "N/A",
    "return_method": "happy-returns",
    "return_method_rma_code": "HR01234",
    "return_method_state": "in_transit",
    "date_delivered": "N/A",
    "outcome": "exchange",
    "scannable_id": "N/A",
    "package_reference": "9999999999999999999999",
    "shipping_box_barcode": "N/A",
    "provider_created_at": "2021-01-01T10:00:00.000Z",
    "destination_id": "17",
    "destination_name": "Maine Warehouse",
    "destination_address1": "55 Maine Street",
    "destination_address2": "Unit 3",
    "destination_city": "Portland",
    "destination_state": "Maine",
    "destination_zip": "54321",
    "consolidation_tracking": "N/A"
  }
]

Authorizations

X-Authorization

string

header

required

Query Parameters

from

string

Response

200

application/json

Success

integer

The unique identifier associated with the ASN report.

return_line_item_id

string

The unique identifier associated with the line item.

order_id

string

The unique identifier associated with the order.

order_name

string

The name of the order.

order_number

string

The order number.

provider_order_number

string

The Shopify or other provider order number.

state

enum<string>

The status of the return.

Available options:

open,

closed,

expired,

cancelled,

review

customer_email

string

The customer's email address.

title

string

The product's name.

purchase_price

string

The product's purchase price.

sku

string

The SKU associated with the product.

barcode

string

The barcode of the product.

carrier

string

The carrier associated with the return.

service

string

The service used to ship the return.

label_status

string

The delivery status of the return.

tracking_number

string

The tracking number associated with the return.

integration_tracking_url

string

The link to the tracking details.

restock_status

string

The restock status of the return.

currency

string

The currency code of the store's default currency.

label_updated_at

string

The date and time at which the label was last updated, using the ISO 8601 date format.

label_url

string

The link to the shipping label.

label_rate

string

The shipping rate paid for the return label.

closed_at

string

The date and time at which the return was closed, using the ISO 8601 date format.

updated_at

string

The date and time at which the return was last updated, using the ISO 8601 date format.

created_at

string

The date and time at which the return was created, using the ISO 8601 date format.

return_reason

string

The specific reason for return given by the customer.

actioned_by

string

The method in which the return was actioned.

return_method

string

The return method.

return_method_rma_code

string

The return material authorization code.

return_method_state

string

The status of the return.

date_delivered

string

The delivery date of the return.

outcome

enum<string>

The outcome of the return as limited by the merchant and as selected by the customer.

Available options:

exchange,

upsell,

refund,

credit,

exchange+refund,

exchange+credit

scannable_id

string

The scannable identifier of the return.

package_reference

string

The package reference of the return.

shipping_box_barcode

string

The barcode for the box in which the return was shipped.

provider_created_at

string

The date and time at which the return was created by the provider, using the ISO 8601 date format.

destination_id

string

The unique identifier associated with the return's destination.

destination_name

string

The name of the destination.

destination_address1

string

The street address of the destination.

destination_address2

string

The secondary address details of the destination.

destination_city

string

The city in which the destination is located.

destination_state

string

The state in which the destination is located.

destination_zip

string

The ZIP code of the destination.

consolidation_tracking

string

If a line item is part of a consolidated shipment of many return items, this value holds the tracking value for the consolidated shipment that contains this item such as the Happy Returns Outbound Shipment tracking number.

Get Return Details Get Webhooks

curl --request GET \
  --url https://api.loopreturns.com/api/v1/warehouse/reporting/asn \
  --header 'X-Authorization: <api-key>'

[
  {
    "id": 17,
    "return_line_item_id": "36",
    "order_id": "2685651685584",
    "order_name": "#1138",
    "order_number": "138",
    "provider_order_number": "1138",
    "state": "open",
    "customer_email": "h.testman@loopreturns.com",
    "title": "Mens Large Hydrostatic Inflatable PFD",
    "purchase_price": "199.99",
    "sku": "ad-alias-corporis-cum-ut-facilis-sed-non",
    "barcode": "789765484987",
    "carrier": "USPS",
    "service": "Parcel Select",
    "label_status": "out_for_delivery",
    "tracking_number": "9999999999999999999999",
    "integration_tracking_url": "N/A",
    "restock_status": "restocked",
    "currency": "USD",
    "label_updated_at": "2023-08-21T14:09:17.000Z",
    "label_url": "https://test-bucket.s3-us-west-2.amazonaws.com/files/postage_label/01234567/0df7eea6147b44b7ac204e9eb8293cfa.pdf",
    "label_rate": "250",
    "closed_at": "2023-09-01T14:00:41.000Z",
    "updated_at": "2023-08-21T14:06:32.000Z",
    "created_at": "2023-08-21T14:05:56.000Z",
    "return_reason": "Size was too small",
    "actioned_by": "N/A",
    "return_method": "happy-returns",
    "return_method_rma_code": "HR01234",
    "return_method_state": "in_transit",
    "date_delivered": "N/A",
    "outcome": "exchange",
    "scannable_id": "N/A",
    "package_reference": "9999999999999999999999",
    "shipping_box_barcode": "N/A",
    "provider_created_at": "2021-01-01T10:00:00.000Z",
    "destination_id": "17",
    "destination_name": "Maine Warehouse",
    "destination_address1": "55 Maine Street",
    "destination_address2": "Unit 3",
    "destination_city": "Portland",
    "destination_state": "Maine",
    "destination_zip": "54321",
    "consolidation_tracking": "N/A"
  }
]

Using the API

APIs

Required API key scope

Authorizations

Query Parameters

Response