PATCH /entities/{entityUid}/tradingAddress
A partial update of an existing Merchant Entity Address. Only replaces the provided parameters.
Servers
- https://emea.gsc.verifone.cloud/oidc/order-service
- https://us.gsc.verifone.cloud/oidc/order-service
- https://nz.gsc.verifone.cloud/oidc/order-service
- https://cst.test-gsc.vfims.com/oidc/order-service
- https://uscst-gb.gsc.vficloud.net/oidc/order-service
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
entityUid |
String | Yes |
The Verifone assigned ID corresponding to the entity. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
addressLine3 |
String | No |
Address Line 3 |
receiverName |
String | No |
The receiver name for the address if different to the company/site name. |
countrySubdivision |
String | No |
Identifies a sub-division of a country which may be state, region or county. This follows a similar format to the openbank api. |
postCode |
String | No |
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. |
poBox |
String | No |
The PO BOX number. |
country |
String | No |
The ISO 3166-1 alpha-3 country code. Note: The country code for Great Britain is. Valid values:
|
addressLine1 |
String | No |
Address Line 1. Should include street and apartment number if required. |
city |
String | No |
Name of a built-up area, with defined boundaries, and a local government. This could be city or town. |
timeZone |
String | No |
A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/New_York and Etc/UTC. Do not use ambiguous, non-qualified values such as EST or GB. Before including this type in your interface, please consider whether it is actually appropriate to convey time zone information with your type. It is almost always the case that this should be transformed from UTC at the time of display to the user; this type might therefore be most associated with user-preference APIs. |
addressLine2 |
String | No |
Address Line 2 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.