Get Deliver Locations

This endpoint returns the list of available delivery locations for a given terminal, category, and state. It is used in flows involving physical goods that require delivery configuration.

🔍 Description

Use this method to:

Retrieve delivery points or zones within a selected state

Configure the final delivery location before product selection

Dynamically determine the next step using nextPath and nextField

📥 Request Details

Method: GET

Authentication: Required

Path Parameters:

terminalId (integer)

categoryId (integer)

stateId (integer)

📤 Response

Returns an array of delivery location objects:

Field	Type	Description
`locationId`	integer	Unique identifier of the delivery location
`name`	string	Display name of the location
`nextPath`	string	Path to the next endpoint in the flow
`nextField`	string	Field name required in the next step, as defined in Get Labels

Example

[
  {
    "locationId": 401,
    "name": "Mercado Central",
    "nextPath": "/physical-products/products/{terminalId}/101/401",
    "nextField": "productId"
  }
]

🧠 Usage Notes

This step is only present for products that require physical delivery.

Use nextPath and nextField to determine the next endpoint and required parameter.

The locationId is used to retrieve available products for that delivery point.

Responses

🟢200OK

application/json

Body

array of:

locationId

integer

required

name

string

required

name

nextPath

string

required

nextField

string

required

Example

[
    {
        "locationId": 5,
        "name": "location",
        "nextPath": "/physical-products/{{nextPath}}/{{terminalId}}/{{levelId}}",
        "nextField": "{nextField}"
    }
]

Get Deliver Locations

🔍 Description#

📥 Request Details#

📤 Response#

Example#

🧠 Usage Notes#

Request

Request samples

Responses

🔍 Description

📥 Request Details

📤 Response

Example

🧠 Usage Notes