---
title: "Get list of shipment option need to create new shipment."
method: GET
path: "/rest/api/shipping/carrier-account/{carrierAccountId}/method/{method}/map/"
tags: ["Shipment"]
---

# Get list of shipment option need to create new shipment.

`GET /rest/api/shipping/carrier-account/{carrierAccountId}/method/{method}/map/`

List of shipment options need to create new shipment.

## Path parameters

- `carrierAccountId` string, required
- `method` string, required

## Response `200`

Returns list of shipment options need to create new shipment.

- RestShipmentOptionsAndParcelsDTO — This object represents options describing shipment and way of dividing into several parcels.
  - `options` RestShipmentOptionsDefinitionDTO — This object represents options describing shipment. You will learn from it what the definitions of individual options look like and which of them are mandatory.
    - `id` string — Option ID.
    - `type` 'boolean' | 'integer' | 'string' | 'choice' | 'money' | 'dimensions' — Option type.
    - `label` string — A label that describes an option.
    - `multiple` boolean — Specifies whether the application expects one or many objects of this type.
    - `properties` RestShipmentOptionDTO[] — List of options describing the shipment as delivery method, insurance, pickup point, etc.
      - `id` string — Option ID.
      - `type` 'boolean' | 'integer' | 'string' | 'choice' | 'money' | 'dimensions' — Option type.
      - `label` string — A label that describes an option.
    - `required` unknown[] — List of required options.
      - unknown
  - `parcels` RestShipmentOptionsDefinitionDTO — This object represents options describing shipment. You will learn from it what the definitions of individual options look like and which of them are mandatory.
    - `id` string — Option ID.
    - `type` 'boolean' | 'integer' | 'string' | 'choice' | 'money' | 'dimensions' — Option type.
    - `label` string — A label that describes an option.
    - `multiple` boolean — Specifies whether the application expects one or many objects of this type.
    - `properties` RestShipmentOptionDTO[] — List of options describing the shipment as delivery method, insurance, pickup point, etc.
      - `id` string — Option ID.
      - `type` 'boolean' | 'integer' | 'string' | 'choice' | 'money' | 'dimensions' — Option type.
      - `label` string — A label that describes an option.
    - `required` unknown[] — List of required options.
      - unknown
  - `maxParcelsCount` integer — Number of parcels into which the shipment can be divided.

## Other responses

- `401` — Authorization failed
- `422` — Unprocessable Entity

---

[API](https://skmtc.dev/apilo/apis/apilo-rest-api.md) · [All operations](https://skmtc.dev/apilo/apis/apilo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/apilo/apilo-rest-api/revisions/a0f9dcdba6cc/schema)