Beckn Gateway
Beckn Gateway API
API Spec for Beckn Gateway
Version: 0.7.1
/search
POST
Description:
Search by intent
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/select
POST
Description:
Select the preferred service. This also allows selection of items from the catalog. Equivalent to selecting a service and adding items to cart.
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/confirm
POST
Description:
Confirm a Service. Equivalent to checkout operation
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/track
POST
Description:
Track a service or and item
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/cancel
POST
Description:
Cancel a Service
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/complete
POST
Description:
Complete a service
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/add
POST
Description:
Add a runtime object to a collection within a service instance object
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/remove
POST
Description:
Add a runtime object to a collection within a service instance object
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/update
POST
Description:
Remove object
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_search
POST
Description:
Callback response to search
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_select
POST
Description:
Callback response to select/service
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_confirm
POST
Description:
Callback response to confirm/service
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_track
POST
Description:
Provide tracking info
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_cancel
POST
Description:
Response to cancel service
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_add
POST
Description:
Returns updated service with added runtime object
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_remove
POST
Description:
Returns updated service with removed runtime object
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |
/on_update
POST
Description:
Returns updated service with updated runtime object
Responses
| Code | Description |
|---|---|
| 200 | Acknowledgement of message received |