{"_id":"5bcf3922e8455d049c357e5a","category":{"_id":"5bcf3922e8455d049c357e16","version":"5bcf3922e8455d049c357ed7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":8,"slug":"resources","title":"Resources"},"user":"560d5913af97231900938124","parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5bcf3922e8455d049c357ed7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b8ec6a1f8dd7c0003386069","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5bcf3922e8455d049c357e0e","5bcf3922e8455d049c357e0f","5bcf3922e8455d049c357e10","5bcf3922e8455d049c357e11","5bcf3922e8455d049c357e12","5bcf3922e8455d049c357e13","5bcf3922e8455d049c357e14","5bcf3922e8455d049c357e15","5bcf3922e8455d049c357e16","5bcf3922e8455d049c357e17","5bcf3922e8455d049c357e18"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27.2 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-24T15:44:38.494Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`currency`\",\n    \"0-1\": \"*string*\",\n    \"h-3\": \"Description\",\n    \"0-3\": \"Cart currency code (ISO 4217).\\nSee [Currency codes](/docs/currency-codes).\",\n    \"0-2\": \"Optional\",\n    \"1-0\": \"`ip`\",\n    \"1-3\": \"Shopper's IP address.\",\n    \"1-2\": \"Optional\",\n    \"2-2\": \"Optional\",\n    \"3-2\": \"Optional\",\n    \"4-2\": \"Optional\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*string*\",\n    \"4-1\": \"*long*\",\n    \"3-1\": \"*string*\",\n    \"2-0\": \"`country`\",\n    \"3-0\": \"`state`\",\n    \"4-0\": \"`store-id`\",\n    \"2-3\": \"Shopper's country.\\nSee [Country codes](/docs/country-codes).\",\n    \"3-3\": \"Shopper's state.\\nSee [State and province codes](/docs/state-and-province-codes).\",\n    \"4-3\": \"ID of the store.\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n###Response\nN/A","excerpt":"","slug":"cart-params","type":"basic","title":"cart-params"}

Request

Property Name
Type
Required
Description

currency

string

Optional

Cart currency code (ISO 4217).
See Currency codes.

ip

string

Optional

Shopper's IP address.

country

string

Optional

Shopper's country.
See Country codes.

state

string

Optional

Shopper's state.
See State and province codes.

store-id

long

Optional

ID of the store.

Response

N/A