For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set Pickup Location As Default

Use this endpoint to mark a specific pickup location as the default location. This page explains how to set a preferred pickup location using its pickup location ID as default

Set Pickup Location As Default

Sets a specific merchant pickup location as the default location.

Method: PATCH Endpoint: https://api.dev.fincart.io/merchant/locations/{locationId}/default


Path Parameters

Parameter
Type
Required
Description

locationId

string

Yes

The unique ID of the pickup location to set as default.

Example: 685403218153cbdceab3aa2f


Request Headers

Header
Value
Required
Description

Authorization

<api_key>

Yes

Merchant API key for authentication.

Content-Type

application/json

Yes

Must be application/json.

Authentication format: The Authorization header uses the format <publicKey>:<signature>:<nonce>.


Request Body

No request body is required for this endpoint.


Response

200 — Success

Field
Type
Description

status

string

“success” when the operation completes.

msg

string

Human-readable confirmation message.

body._id

string

The ID of the location that was set as default.


Example Request


Notes

  • This endpoint requires no body — only the locationId in the URL path.

  • Only one location can be the default at a time. Calling this endpoint on a new location will replace the previous default.


Last updated