> For the complete documentation index, see [llms.txt](https://docs.prestashop-project.org/1-5-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.prestashop-project.org/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md).
# Web service reference
**Table of contents**
/\*\\*/
* [Web service reference](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Webservicereference)
* [Using the API](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-UsingtheAPI)
* [Available HTTP methods](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-AvailableHTTPmethods)
* [Available resources](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Availableresources)
* [Value formats](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Valueformats)
* [Generic value types](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Genericvaluetypes)
* [Specific value types](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Specificvaluetypes)
* [Names](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Names)
* [Locations](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Locations)
* [Products](/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md#Webservicereference-Products)
## Web service reference
### Using the API
All methods are to be called through the `/api/` gateway. For instance, `http://www.mystore.com/api/carriers`
#### Available HTTP methods
Most methods can be accessed in a REST manner, with the 5 main HTTP request methods: GET, POST, PUT, DELETE, HEAD.\
The only exceptions are:
* `product_suppliers`: only GET and HEAD.
* `search`: only GET and HEAD.
* `stock_availables`: only GET, POST, and HEAD.
* `stock_movements`: only GET and HEAD.
* `stocks`: only GET and HEAD.
* `supply_order_details`: only GET and HEAD.
* `supply_order_histories`: only GET and HEAD.
* `supply_order_receipt_histories`: only GET and HEAD.
* `supply_order_states`: only GET and HEAD.
* `supply_orders`: only GET and HEAD.
* `warehouse_product_locations`: only GET and HEAD.
* `warehouses`: only GET, POST, PUT, and HEAD.
All methods have two optional types, which are simply to be added at the end of the URL:
* `?blank`: returns a blank XML tree of the chosen object.
* `?synopsis`: returns a blank XML tree of the chosen object, with the format that is expected for each value (see below) and specific indicators (ie, if the node is required, and its maximum size in number of characters).
#### Available resources
This list is current as of v1.5.4.1 of PrestaShop.
| Method | Description |
| --------------------------------- | ------------------------------------------------- |
| addresses | The Customer, Manufacturer and Customer addresses |
| carriers | The Carriers |
| cart\_rules | Cart rules management |
| carts | Customer's carts |
| categories | The product categories |
| combinations | The product combination |
| configurations | Shop configuration |
| contacts | Shop contacts |
| content\_management\_system | Content management system |
| countries | The countries |
| currencies | The currencies |
| customer\_messages | Customer services messages |
| customer\_threads | Customer services threads |
| customers | The e-shop's customers |
| deliveries | Product delivery |
| employees | The Employees |
| groups | The customer's groups |
| guests | The guests |
| image\_types | The image types |
| images | The images |
| images/general/header | The shop's logo in the header |
| images/general/mail | The shop's logo in the e-mails |
| images/general/invoice | The shop's logo in the invoice |
| images/general/store\_icon | The shop's logo as a favicon |
| images/products | The products images. |
| images/categories | The categories images |
| images/manufacturers | The manufacturers images. |
| images/suppliers | The suppliers images. |
| images/stores | The stores images. |
| languages | Shop languages |
| manufacturers | The product manufacturers |
| order\_carriers | Details of an order |
| order\_details | Details of an order |
| order\_discounts | Discounts of an order |
| order\_histories | The Order histories |
| order\_invoices | The Order invoices |
| order\_payments | The Order payments |
| order\_states | The Order states |
| orders | The Customers orders |
| price\_ranges | Price range |
| product\_feature\_values | The product feature values |
| product\_features | The product features |
| product\_option\_values | The product options value |
| product\_options | The product options |
| product\_suppliers | Product Suppliers |
| products | The products |
| search | Search |
| shop\_groups | Shop groups from multi-shop feature |
| shops | Shops from multi-shop feature |
| specific\_price\_rules | Specific price management |
| specific\_prices | Specific price management |
| states | The available states of countries |
| stock\_availables | Available quantities |
| stock\_movement\_reasons | The stock movement reason |
| stock\_movements | Stock movements management |
| stocks | Stocks |
| stores | The stores |
| suppliers | The product suppliers |
| supply\_order\_details | Supply Order Details |
| supply\_order\_histories | Supply Order Histories |
| supply\_order\_receipt\_histories | Supply Order Receipt Histories |
| supply\_order\_states | Supply Order States |
| supply\_orders | Supply Orders |
| tags | The Products tags |
| tax\_rule\_groups | Tax rule groups |
| tax\_rules | Tax rules entity |
| taxes | The tax rate |
| translated\_configurations | Shop configuration |
| warehouse\_product\_locations | Location of products in warehouses |
| warehouses | Warehouses |
| weight\_ranges | Weight ranges |
| zones | The Countries zones |
### Value formats
When displaying a data schema in synopsis mode, the API gives some useful indication of the expected data type.
For instance:
```
...
```
Here are the descriptions of the expected value types.
#### Generic value types
| Format | Description | Expected value, in regexp form |
| ------------------ | --------------------------------------------------------------------------- | ------------------------------ |
| isBool | A boolean value (true or false). | n/a |
| isFloat | A floating-point value (between -3.4 × 10^38 and +3.4 × 10^38). | n/a |
| isInt | An integral value (between -2,147,483,648 and 2,147,483,647). | n/a |
| isNullOrUnsignedId | An integral and unsigned value (between 0 and 4294967296), or a NULL value. | n/a |
| isSerializedArray | PHP serialized data. | |
| isString | A string of characters. | n/a |
| isUnsignedId | An integral and unsigned value (between 0 and 4294967296). | n/a |
#### Specific value types
| Format | Description | Expected value, in regexp form |
| -------------------- | ---------------------------------------------------------------------------------------------------- | ------------------------------ |
| isBirthDate | A valid date, in YYYY-MM-DD format. | |
| isCleanHtml | Must not contain invalid HTML tags, nor XSS. | |
| isColor | A valid HTML/CSS color, in #xxxxxx format or text format. | |
| isEmail | A valid e-mail address. | |
| isImageSize | A valid image size, between 0 and 9999. | |
| isLanguageCode | A valid language code, in XX or XX-XX format. | |
| isLanguageIsoCode | A valid ISO language code, in XX or XXX format. | |
| isLinkRewrite | A valid link rewrite. | |
| isMd5 | A valid MD5 string: 32 characters, mixing lowercase, uppercase and numerals. | |
| isNumericIsoCode | A valid ISO code, in 00 or 000 format. | |
| isPasswd | A valid password, in. between 5 and 32 characters long. | |
| isPasswdAdmin | A valid password, between 8 and 32 characters long. | |
| isPhpDateFormat | A valid PHP date – in fact, a string without '`<`' nor `'>`'. | |
| isPriceDisplayMethod | A valid price display method, meaning the value be equals to constants `PS_TAX_EXC` or `PS_TAX_INC`. | n/a |
| isReference | A valid product reference. | |
| isUrl | A valid URL. | |
#### Names
| Format | Description | Expected value, in regexp form |
| --------------- | --------------------------------- | ------------------------------ |
| isCatalogName | A valid product or category name. | |
| isCarrierName | A valid carrier name. | |
| isConfigName | A valid configuration key. | |
| isGenericName | A valid standard name. | |
| isImageTypeName | A valid image type. | |
| isName | A valid name. | |
| isTplName | A valid template name. | |
#### Locations
| Format | Description | Expected value, in regexp form |
| --------------- | ----------------------------------------------------------- | ------------------------------ |
| isAddress | A valid postal address. | |
| isCityName | A valid city name. | |
| isCoordinate | A valid latitude-longitude coordinates, in 00000.0000 form. | |
| isMessage | A valid message. | |
| isPhoneNumber | A valid phone number. | |
| isPostCode | A valid postal code. | |
| isStateIsoCode | A valid state ISO code. | |
| isZipCodeFormat | A valid zipcode format. | |
#### Products
| Format | Description | Expected value, in regexp form |
| ------------- | -------------------------------------------------------------------------------------- | ------------------------------ |
| isAbsoluteUrl | A valid absolute URL. | |
| isDniLite | A valid DNI (*Documento Nacional de Identidad*) identifier. Specific to Spanish shops. | |
| isEan13 | A valid barcode (EAN13). | |
| isLinkRewrite | A valid friendly URL. | |
| isPrice | A valid price display method (either `PS_TAX_EXC` or `PS_TAX_INC`). | n/a |
| isUpc | A valid barcode (UPC). | |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.prestashop-project.org/1-5-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.