---
title: "order.preestimate_shipping.list"
method: POST
path: "/order.preestimate_shipping.list.json"
tags: ["order"]
---

# order.preestimate_shipping.list

`POST /order.preestimate_shipping.list.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/order.preestimate_shipping.list.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Retrieve list of order preestimated shipping methods

## Request body

- OrderPreestimateShippingList
  - `warehouse_id` string: This parameter is used for selecting a warehouse where you need to set/modify a product quantity.
  - `customer_id` string: Retrieves orders specified by customer id
  - `customer_email` string: Retrieves orders specified by customer email
  - `store_id` string: Store Id
  - `shipp_address_1` string: Specifies first shipping address
  - `shipp_city` string: Specifies shipping city
  - `shipp_postcode` string: Specifies shipping postcode
  - `shipp_state` string: Specifies shipping state code
  - `shipp_country` string, required: Specifies shipping country code
  - `params` string: Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve
  - `exclude` string: Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter `params` equal force_all
  - `idempotency_key` string: A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>
  - `order_item` object[], required
    - `order_item_id` string, required: Defines orders specified by order item id
    - `order_item_model` string: Defines orders specified by order item model
    - `order_item_quantity` integer, required: Defines orders specified by order item quantity
    - `order_item_weight` number: Defines orders specified by order item weight
    - `order_item_variant_id` string: Ordered product variant. Where x is order item ID
    - `order_item_option` object[]
      - `order_item_option_name` string: Ordered Product Option Name. Where x is order item ID, y is order item option ID
      - `order_item_option_id` string: Product Option ID. Where x is order item ID, y is order item option ID
      - `order_item_option_value` string: Ordered product option value Where x is order item ID, y - order item option ID
      - `order_item_option_value_id` string: Product option value ID, where x is order item ID, y - order item option ID
      - `order_item_option_used_in_combinations` boolean: Product option used in combinations flag, where x is order item ID, y - order item option ID

## Response `200`

successful operation

- ModelResponseOrderPreestimateShippingList
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `pagination` Pagination
    - `previous` string, nullable
    - `next` string, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `result` ResponseOrderPreestimateShippingListResult
    - `preestimate_shippings_count` integer, nullable
    - `preestimate_shippings` OrderPreestimateShipping[]
      - `method_code` string
      - `method_name` string, nullable
      - `carrier_code` string, nullable
      - `carrier_name` string, nullable
      - `description` string, nullable
      - `price` number, nullable
      - `price_inc_tax` number, nullable
      - `delivery_time` string, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)