Shipment

Get list of shipment option need to create new shipment.

List of shipment options need to create new shipment.

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

Path parameters

carrierAccountIdstring required

Carrier account ID

methodstring required

Delivery method

Response

Returns list of shipment options need to create new shipment.

maxParcelsCountinteger

Number of parcels into which the shipment can be divided.

Example response

{
  "options": {
    "id": "options",
    "type": "definition",
    "label": "Shipping options",
    "multiple": true,
    "properties": [
      {
        "id": "cod",
        "type": "money",
        "label": "Shipping COD"
      }
    ],
    "required": [
      "cod",
      "dropoffPoint"
    ]
  },
  "parcels": {
    "id": "options",
    "type": "definition",
    "label": "Shipping options",
    "multiple": true,
    "properties": [
      {
        "id": "cod",
        "type": "money",
        "label": "Shipping COD"
      }
    ],
    "required": [
      "cod",
      "dropoffPoint"
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.