Fulfillment inboundWfs Inbound

Returns a list of inbound plans with minimal information.

GET
/inbound/wfs/v4/inboundPlans

Authorization

sellerAuth
AuthorizationBearer <token>

In: header

Query Parameters

pageSize?integer

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

Range1 <= value <= 30
Default10
paginationToken?string

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

Length0 <= length <= 1024
status?string

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

sortBy?string

Sort by field.

sortOrder?string

The sort order. Possible values: ASC, DESC.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/inbound/wfs/v4/inboundPlans"
{  "inboundPlans": [    {      "createdAt": "2019-08-24T14:15:22Z",      "inboundPlanId": "stringstringstringstringstringstringst",      "lastUpdatedAt": "2019-08-24T14:15:22Z",      "marketplaceIds": [        "string"      ],      "name": "string",      "sourceAddress": {        "addressLine1": "string",        "addressLine2": "string",        "city": "string",        "companyName": "string",        "countryCode": "st",        "districtOrCounty": "string",        "email": "string",        "name": "string",        "phoneNumber": "string",        "postalCode": "string",        "stateOrProvinceCode": "string"      },      "status": "string"    }  ],  "pagination": {    "nextToken": "string"  }}