Returns a list of inbound plans with minimal information.

{
  "inboundPlans": [
    {
      "createdAt": "2024-01-15T09:30:00Z",
      "inboundPlanId": "string",
      "lastUpdatedAt": "2024-01-15T09:30:00Z",
      "marketplaceIds": [
        "string"
      ],
      "name": "string",
      "sourceAddress": {
        "addressLine1": "string",
        "city": "string",
        "countryCode": "string",
        "name": "string",
        "postalCode": "string",
        "addressLine2": "string",
        "companyName": "string",
        "districtOrCounty": "string",
        "email": "string",
        "phoneNumber": "string",
        "stateOrProvinceCode": "string"
      },
      "status": "string"
    }
  ],
  "pagination": {
    "nextToken": "string"
  }
}

Query parameters

pageSizeintegerOptional1-30Defaults to 10

The number of inbound plans to return in the response matching the given query.

paginationTokenstringOptional0-1024 characters

A token to fetch a certain page when there are multiple pages worth of results.

statusstringOptional

The status of an inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.

sortBystringOptional

Sort by field.

sortOrderstringOptional

The sort order. Possible values: ASC, DESC.

Response

Success

inboundPlanslist of objectsOptional

A list of inbound plans with minimal information.

paginationobjectOptional

Contains tokens to fetch from a certain page.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error