Get All Destinations

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

{
  "destinations": [
    {
      "id": 1,
      "type": "warehouse",
      "name": "Example Destination",
      "enabled": true,
      "address": {
        "address1": "123 Main St",
        "address2": "Unit 456",
        "city": "Columbus",
        "state": "Ohio",
        "zip": "43210",
        "country": "United States",
        "country_code": "US"
      }
    }
  ]
}

GET

destinations

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

{
  "destinations": [
    {
      "id": 1,
      "type": "warehouse",
      "name": "Example Destination",
      "enabled": true,
      "address": {
        "address1": "123 Main St",
        "address2": "Unit 456",
        "city": "Columbus",
        "state": "Ohio",
        "zip": "43210",
        "country": "United States",
        "country_code": "US"
      }
    }
  ]
}

Authorizations

X-Authorization

string

header

required

Response

Success

destinations

object[]

Show child attributes

destinations.id

integer

The destination's unique identifier.

Example:

1

destinations.type

enum<string>

The type of location represented by the destination.

Available options:

warehouse,

donate

Example:

"warehouse"

destinations.name

string

The destination's name.

Example:

"Example Destination"

destinations.enabled

boolean

Whether the destination is enabled as a return destination.

Example:

true

destinations.address

object

The destination's address.

Show child attributes

destinations.address.address1

string

The street address of the destination.

Example:

"123 Main St"

destinations.address.address2

string | null

The secondary address details of the destination.

Example:

"Unit 456"

destinations.address.city

string

Example:

"Columbus"

destinations.address.state

string | null

Example:

"Ohio"

destinations.address.zip

string | null

Example:

"43210"

destinations.address.country

string

Example:

"United States"

destinations.address.country_code

string

Example:

"US"

Delete Cart Create Destination

⌘I

Using the API

APIs

Get All Destinations

Required API key scope

Authorizations

Response