order

order.preestimate_shipping.list

Retrieve list of order preestimated shipping methods

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

Request body

warehouse_idstring

This parameter is used for selecting a warehouse where you need to set/modify a product quantity.

customer_idstring

Retrieves orders specified by customer id

customer_emailstring

Retrieves orders specified by customer email

store_idstring

Store Id

shipp_address_1string

Specifies first shipping address

shipp_citystring

Specifies shipping city

shipp_postcodestring

Specifies shipping postcode

shipp_statestring

Specifies shipping state code

shipp_countrystring required

Specifies shipping country code

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

excludestring

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_keystring

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>

Example request

{
  "warehouse_id": "1",
  "customer_id": "5",
  "customer_email": "jubari@hannsgroup.com",
  "store_id": "1",
  "shipp_address_1": "Green str. 35",
  "shipp_city": "Chicago",
  "shipp_postcode": "24545",
  "shipp_state": "IL",
  "shipp_country": "US",
  "params": "id,model,price,images",
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6",
  "order_item": [
    {
      "order_item_id": "125, where {x} - 1,2,3,... etc",
      "order_item_model": "sku_1, where {x} - 1,2,3,... etc",
      "order_item_option": [
        {
          "order_item_option_name": "Color",
          "order_item_option_id": "12",
          "order_item_option_value": "green",
          "order_item_option_value_id": "13"
        }
      ]
    }
  ]
}

Response

successful operation

return_codeinteger nullable

return_messagestring nullable

additional_fieldsobject nullable

custom_fieldsobject nullable

Changes

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