Update a Location

patch

https://apis.p2pemanager.com/api/v1/locations/{id}

This endpoint updates an existing Location resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice. For example, this endpoint can be used to change the Location affiliated with a particular Client.

Path Params

string

required

The Location's unique identifier.

Body Params

Location to be updated.

name

string

length ≤ 255

customReference

string

length ≤ 255

A Partner specified reference for a location.

billingId

string

length ≤ 50

nameOfBusiness

string

length ≤ 255

The name of the business at this location.

locationType

string

enum

The Location's clasification.

uniqueId

string

length ≤ 255

Unique Identifier for the Location.

country

object

Reference to the associated Country. When used for POST and PATCH API calls, the reference can contain either the ISO-ALPHA2 country Code or Name.

address1

string

length ≤ 255

The Location's street address.

address2

string

length ≤ 255

The Location's street address.

city

string

length ≤ 255

The Location's city.

stateProvince

string

length ≤ 255

The Location's street state or province.

postalCode

string

length ≤ 10

The Location's postal code.

mailCountry

string

The Location's street address.

mailAddress1

string

length ≤ 255

The Location's street address.

mailAddress2

string

length ≤ 255

The Location's street address.

mailCity

string

length ≤ 255

The Location's city.

mailStateProvince

string

length ≤ 255

The Location's street state or province.

mailPostalCode

string

length ≤ 10

The Location's postal code.

notes

string

Note for delivery driver.

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Location update response

401Unauthorized

403Forbidden

404Not found

409Invalid data

500Internal server error