v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB

Fulfillment Inbound v2024-03-20

getInboundPlan

Fetches the top level information about an inbound plan.

get/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}

Path parameters

inboundPlanIdstring required

Identifier of an inbound plan.

Response

GetInboundPlan 200 response

createdAtstring date-time required

The time at which the inbound plan was created. In ISO 8601 datetime with pattern yyyy-MM-ddTHH:mm:ssZ.

inboundPlanIdstring required

Identifier of an inbound plan.

lastUpdatedAtstring date-time required

The time at which the inbound plan was last updated. In ISO 8601 datetime format with pattern yyyy-MM-ddTHH:mm:ssZ.

marketplaceIdsstring[] required

A list of marketplace IDs.

namestring required

Human-readable name of the inbound plan.

statusstring required

Current status of the inbound plan. Possible values: ACTIVE, VOIDED, SHIPPED, ERRORED.

Example response

{
  "createdAt": "2024-03-20T12:01:00Z",
  "inboundPlanId": "wf1234abcd-1234-abcd-5678-1234abcd5678",
  "lastUpdatedAt": "2024-03-28T13:15:30Z",
  "marketplaceIds": [
    "A2EUQ1WTGCTBG2"
  ],
  "name": "FBA (03/20/2024, 12:01 PM)",
  "packingOptions": [],
  "placementOptions": [],
  "shipments": [],
  "sourceAddress": {
    "addressLine1": "123 example street",
    "addressLine2": "Floor 19",
    "city": "Toronto",
    "companyName": "Acme",
    "countryCode": "CA",
    "email": "email@email.com",
    "name": "name",
    "phoneNumber": "1234567890",
    "postalCode": "M1M1M1",
    "stateOrProvinceCode": "ON"
  },
  "status": "ACTIVE"
}