Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Return Data

Advanced Shipping Notice

This endpoint will pull all packages by tracking statuses/timeframe. The ASN endpoint will return an array of objects. Those objects will contain order and return information.

Required API key scope

  • Returns
get/warehouse/reporting/asn

Query parameters

fromstring date
Example:2023-08-21T00:00:00.000Z

The start of the date range. If omitted, defaults to one week ago at the start of the day. Invalid values fall back to the Unix epoch.

tostring date
Example:2023-08-21T00:00:00.000Z

The end of the date range. If omitted, defaults to the end of the current day. Invalid values fall back to the Unix epoch.

Response

Success

idinteger

The unique identifier associated with the ASN report.

return_line_item_idstring

The unique identifier associated with the line item.

order_idstring

The unique identifier associated with the order.

order_namestring

The name of the order.

order_numberstring

The order number.

provider_order_numberstring

The order number from the commerce provider (e.g. Shopify).

state'open' | 'closed' | 'expired' | 'cancelled' | 'review'
customer_emailstring

The customer's email address.

titlestring

The product's name.

purchase_pricestring

The product's purchase price.

skustring

The SKU associated with the product.

barcodestring

The barcode of the product.

carrierstring

The carrier associated with the return.

servicestring

The service used to ship the return.

label_statusstring

The delivery status of the return.

tracking_numberstring

The tracking number associated with the return.

integration_tracking_urlstring

The link to the tracking details.

restock_statusstring

The restock status of the return.

currencystring

The currency code of the store's default currency.

label_updated_atstring date-time

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

label_urlstring

The link to the shipping label.

label_ratestring

The shipping rate paid for the return label.

closed_atstring date-time

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

updated_atstring date-time

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

created_atstring date-time

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

return_reasonstring

The specific reason for return given by the customer.

actioned_bystring

The method in which the return was actioned.

return_methodstring

The return method.

return_method_rma_codestring

The return material authorization code.

return_method_statestring

The status of the return.

date_deliveredstring

The delivery date of the return.

outcome'exchange' | 'upsell' | 'refund' | 'credit' | 'exchange+refund' | 'exchange+credit'
scannable_idstring

The scannable identifier of the return.

package_referencestring

The package reference of the return.

shipping_box_barcodestring

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

provider_created_atstring date-time

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

destination_idstring

The unique identifier associated with the return's destination.

destination_namestring

The name of the destination.

destination_address1string

The street address of the destination.

destination_address2string

The secondary address details of the destination.

destination_citystring

The city in which the destination is located.

destination_statestring

The state in which the destination is located.

destination_zipstring

The ZIP code of the destination.

consolidation_trackingstring nullable

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.

Example response

[
  {
    "id": 17,
    "return_line_item_id": "36",
    "order_id": "2685651685584",
    "order_name": "#1138",
    "order_number": "138",
    "provider_order_number": "1138",
    "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",
    "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"
  }
]