Update Business Pickup Addresses

PATCH /api/v1/businesses/{businessId}/pickup-addresses

Description

Update the pickup addresses for a specific business.

Path Parameters

Name	Type	Description
businessId	string	The ID of the business (path)

Request Body

• Content Type: application/json

{
  "pickUpAddresses": [
    {
      "address": "string",
      "country": {
        "name": "string",
        "code": "string",
        "currency": "string"
      },
      "state": {
        "name": "string",
        "code": "string"
      },
      "lga": {
        "name": "string",
        "code": "string"
      },
      "latitude": 0,
      "longitude": 0
    }
  ]
}

Response Code: 200 - OK

Description

Pickup addresses updated successfully.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to the updated pickup addresses
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Pickup addresses updated successfully",
  "data": {},
  "errors": []
}

Headers

Content-Type	Value
apiKey	{{apiKey}}

Body

{
  "pickUpAddresses": [
    {
      "address": "123 Main Street",
      "country": {
        "name": "USA",
        "code": "US",
        "currency": "USD"
      },
      "state": {
        "name": "California",
        "code": "CA"
      },
      "lga": {
        "name": "Los Angeles County",
        "code": "LAC"
      },
      "latitude": 34.0522,
      "longitude": -118.2437
    }
  ]
}

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string