Retrieves a list of placement options for an inbound plan.

{
  "placementOptions": [
    {
      "discounts": [
        {
          "description": "string",
          "target": "string",
          "type": "string",
          "value": {
            "amount": 1.1,
            "code": "string"
          }
        }
      ],
      "fees": [
        {
          "description": "string",
          "target": "string",
          "type": "string",
          "value": {
            "amount": 1.1,
            "code": "string"
          }
        }
      ],
      "placementOptionId": "string",
      "shipmentIds": [
        "string"
      ],
      "status": "string",
      "expiration": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "nextToken": "string"
  }
}

Path parameters

inboundPlanIdstringRequired

Identifier of an inbound plan.

Query parameters

pageSizeintegerOptional1-30

The number of placement options to return in the response matching the given query.

paginationTokenstringOptional

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

Response

Success

placementOptionslist of objects

Placement options generated for the inbound plan.

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