This article contains the technical specifications of Paazl's SOAP API updateStores call.
Use this call to update the information on Click & Collect store locations in your Paazl web app account.
Request
Note
You have to assign values to all the elements in the request, not just the ones you want to change.
Element specifications
| Element | Type | Required? | Description |
|---|---|---|---|
webshop | long | Yes | The Webshop ID of your main webshop. You will find this in the Paazl UI under Settings > My Account |
targetWebshop | long | No | If you use multiple webshops, this is the webshop ID of a child webshop (a.k.a. Paazl sub-account). You will find it in the Paazl web app account of the child webshop concerned under Settings > My Account. The |
store | complex element | Yes | Contains details of the store you want to update |
code | String | Yes | The unique code that you assigned to the store that you are updating |
name | String | Yes | The name of the store you are creating |
address | complex element | Yes | Contains the address details of a store |
street | String | Yes | The street in which a store is located |
housenumber | String | Yes | The house number of a store location |
addition | String | No | The house number extension of a store location |
additionalAddressLine | String | No | Use this if you need to add additional information about a store's location |
postcode | String | Yes | The postal code of a store location |
city | String | Yes | The city in which a store is located |
province | String | No | The province in which a store is located Note: This is mandatory for FedEx US, Mexico and Canada shipments (if EEI applies). |
country | String | Yes | The ISO 3166-2 code for the country in which a store is located. The default value is |
coordinates | complex element | Yes | The geographical coordinates of a store location |
latitude | decimal | Yes | The geographical latitude of a store location |
longitude | decimal | Yes | The geographical longitude of a store location |
businessHours | complex element | No | Contains details of a store's opening times Note: Although this is not required, we highly recommend that you specify a store's opening times so that they can be displayed to your customers. |
day | enumeration | No | Days on which a store is open. Possible values are: Note: The day names must be all upper case |
from | time | No | Time of day at which a store opens Format: "00:00:00" |
until | time | No | Time of day at which a store closes Format: "00:00:00" |
hash | String | Yes | An SHA-1 encrypted authentication code. The string you encrypt is a concatenation of the following substrings: <webshop ID> + <integration password> + <store code> Example Webshop ID: "123" Integration password: "myPassword" Store code: "Store12" String to encrypt: "123myPasswordStore12" |
Sample request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mat="http://www.paazl.com/schemas/matrix"> <soapenv:Header/> <soapenv:Body> <mat:createStoresRequest> <mat:webshop>804</mat:webshop> <!--Optional:--> <mat:targetWebshop>?</mat:targetWebshop> <!--1 or more repetitions:--> <mat:store> <mat:code>store1</mat:code> <mat:name>A'dam Mc Tosch 1</mat:name> <mat:address> <!--You have a CHOICE of the next 2 items at this level--> <mat:street>Smitstraat</mat:street> <mat:housenumber>26</mat:housenumber> <!--Optional:--> <mat:addition>I</mat:addition> <mat:address>?</mat:address> <!--Zero or more repetitions:--> <mat:additionalAddressLine>?</mat:additionalAddressLine> <mat:postcode>1092XS</mat:postcode> <mat:city>Amsterdam</mat:city> <!--Optional:--> <mat:province>Noord Holland</mat:province> <!--Optional:--> <mat:country>NL</mat:country> </mat:address> <!--Optional:--> <mat:coordinates> <mat:latitude>52.354604</mat:latitude> <mat:longitude>4.922024</mat:longitude> </mat:coordinates> <!--Zero or more repetitions:--> <mat:businessHours> <mat:day>MONDAY</mat:day> <mat:from>09:00:00</mat:from> <mat:until>17:00:00</mat:until> </mat:businessHours> <mat:businessHours> <mat:day>TUESDAY</mat:day> <mat:from>09:00:00</mat:from> <mat:until>18:00:00</mat:until> </mat:businessHours> <mat:hash>eb31a1d235c5645660d9a5caabd7a2883c3ca0e1</mat:hash> </mat:store> <mat:store> <mat:code>store2</mat:code> <mat:name>A'dam Mc Tosch 2</mat:name> <mat:address> <!--You have a CHOICE of the next 2 items at this level--> <mat:street>Smitstraat</mat:street> <mat:housenumber>26</mat:housenumber> <!--Optional:--> <mat:addition>II</mat:addition> <mat:address>?</mat:address> <!--Zero or more repetitions:--> <mat:additionalAddressLine>?</mat:additionalAddressLine> <mat:postcode>1092XS</mat:postcode> <mat:city>Amsterdam</mat:city> <!--Optional:--> <mat:province>Noord Holland</mat:province> <!--Optional:--> <mat:country>NL</mat:country> </mat:address> <!--Optional:--> <mat:coordinates> <mat:latitude>52.354604</mat:latitude> <mat:longitude>4.922024</mat:longitude> </mat:coordinates> <!--Zero or more repetitions:--> <mat:businessHours> <mat:day>MONDAY</mat:day> <mat:from>09:00:00</mat:from> <mat:until>17:00:00</mat:until> </mat:businessHours> <mat:businessHours> <mat:day>TUESDAY</mat:day> <mat:from>09:00:00</mat:from> <mat:until>18:00:00</mat:until> </mat:businessHours> <mat:hash>e1c70874acd57f5b8499feeeb987319050a654d3</mat:hash> </mat:store> </mat:createStoresRequest> </soapenv:Body> </soapenv:Envelope>
Response
Element specifications
| Element | Type | Description |
|---|---|---|
code | String | The unique codes that you assigned to the stores that you updated |
Sample response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <createStoresResponse xmlns="http://www.paazl.com/schemas/matrix"> <code>store1</code> <code>store2</code> </createStoresResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article