Updating a Previously Created Pickup Point in the Directory

This method is used to update a previously created pickup point of any type in the PP directory in the Gold Apple IS. Reasons for an update may include a change in a location's availability, closure for renovation, a change in working hours, and any other events related to a change in the PP's availability or its operating details.

Basic Information

Request method type	PUT
Path / URL	/api/v1/pickpoints/{pickpointId}/update
Description	Method for updating a PP that has been added to the directory stored in the Gold Apple IS. One request — one PP.
Direction	The request is executed by the courier service. The response is provided by the Gold Apple IS.

Request

Request Path Parameters

Parameter	Data type	Required	Description	Comment
id	string	1	Courier service PP identifier	The courier service PP identifier passed when the PP was created in the directory

Header Parameters

Parameter	Data type	Required	Description	Comment
Authorization	string	1	Access token issued by the service	see the Authorization in the Service method
content-type	string	1	Request content type	Filled in as "application/json"

Request Parameters

№	Parameter			Data type	Required	Description	Comment
1	countryISOCode			string (2)	1	Courier service country code	Per the "ISO 3166-1, alpha-2" standard
2	deliveryServiceCode			string (100)	1	Courier service code	Duplicates the information at the object level
3	type			string (20)	1	Pick-up point type	See "Format Tables" → "Table 1"
4	address			object	1	Object containing address data
5		Address object type		object	1	Object containing address information.	Address object (see Appendix: Address Data Types)
6	openingHours			array of objects	1	Array of PP working-hours objects
7		dayOfWeek		enum	1	Identifier of the day for which the working schedule is set	See "Format Tables" → "Table 3"
8		workingDay		bool	1	Working-day flag	If on, the PP operates on this day of the week
9		opens		string (15)	0	PP opening time	Per the "ISO 8601" standard (hh:mm:ss)
10		closes		string (15)	0	PP closing time	Per the "ISO 8601" standard (hh:mm:ss)
11	phoneNumber			string (20)	0	PP phone number	No special characters, digits only (country code and area code)
12	isAvailable			boolean	1	PP availability status	If the flag is on, the PP is active; if off, it is not
13	orderStoragePeriod			int	1	Order storage period, in calendar days	Example: 5
14	options			object	1	Object with options available at the PP
15		orderIssuing		bool	1	Order issuing available	If on, the PP can hand out orders
16		orderReturning		bool	1	Order return available	If on, the PP can accept returns
17		haveTryOn		bool	1	Fitting rooms and try-on available	If on, the PP has fitting rooms
18		havePartialBuy		bool	1	Partial purchase available	I.e. the PP can carry out a partial hand-out
19		packageMinWeight		int	1	Minimum parcel weight for this PP, in grams
20		packageMaxWeight		int	1	Maximum parcel weight for this PP, in grams
21		packageMaxLength		decimal	1	Maximum parcel length for the PP, in centimeters.	Along the X axis. Precise to two decimal places
22		packageMaxHeight		decimal	1	Maximum parcel height for the PP, in centimeters.	Along the Y axis. Precise to two decimal places
23		packageMaxWidth		decimal	1	Maximum parcel width for the PP, in centimeters.	Along the Z axis. Precise to two decimal places
24	paymentOptions			object	1	Object with payment-on-receipt options
25		haveCashPayment		bool	1	Cash-on-delivery available (post-payment)	If on, payment on receipt is possible
26		haveCardPayment		bool	1	Card payment available (terminal)	If on, the PP accepts card payment
27		haveQrCodePayment		bool	1	QR-code payment available (terminal, PP software)	If on, the PP has QR-code payment

Request example

{
  "type": "POSTOMAT",
  "address": {
    "addressType": "coord",
    "fullAddress": "125009, Moscow, Tverskaya St., 7",
    "cityFias": "2763c110-cb8b-416a-9dac-ad28a55b4402",
    "latitude": 55.755816,
    "longitude": 37.617633,
    "flat": "",
    "addressComment": "Parcel locker 'Meridian', 1st floor, near the main entrance"
  },
  "openingHours": [
    {
      "dayOfWeek": 1,
      "workingDay": true,
      "opens": "10:00:00",
      "closes": "22:00:00"
    },
    {
      "dayOfWeek": 2,
      "workingDay": true,
      "opens": "10:00:00",
      "closes": "22:00:00"
    },
    {
      "dayOfWeek": 3,
      "workingDay": true,
      "opens": "10:00:00",
      "closes": "22:00:00"
    },
    {
      "dayOfWeek": 4,
      "workingDay": true,
      "opens": "10:00:00",
      "closes": "22:00:00"
    },
    {
      "dayOfWeek": 5,
      "workingDay": true,
      "opens": "10:00:00",
      "closes": "22:00:00"
    },
    {
      "dayOfWeek": 6,
      "workingDay": false,
      "opens": null,
      "closes": null
    },
    {
      "dayOfWeek": 7,
      "workingDay": false,
      "opens": null,
      "closes": null
    }
  ],
  "phoneNumber": null,
  "isAvailable": true,
  "orderStoragePeriod": 4,
  "options": {
    "orderIssuing": true,
    "orderReturning": false,
    "haveTryOn": false,
    "havePartialBuy": false,
    "packageMinWeight": 50,
    "packageMaxWeight": 3000,
    "packageMaxLength": 45,
    "packageMaxHeight": 27.9,
    "packageMaxWidth": 30
  },
  "paymentOptions": {
    "haveCashPayment": false,
    "haveCardPayment": true,
    "haveQrCodePayment": true
  }
}

Response

Response Codes and Messages

Code	Status	Message	Reason
200	OK	Pickpoint has been updated.	Everything completed successfully. The pickup point information was updated
400	Bad Request	Missing or inappropriate required parameters	Required parameters are missing or invalid.
401	Unauthorized	Token is invalid	Authentication error at the courier service
403	Forbidden	Has no permission	Insufficient permissions
500	Internal Server Error	Server unavailable	The server is unavailable

Successful Response Parameters

200 OK

Unsuccessful Response Parameters

Parameter	Data type	Required	Description	Comment
error	string	1	Human-readable description of the error	see the "Response Codes and Messages" section

Unsuccessful response example

{
  "error": "Invalid request format"
}