--- agentTools: projectIndex: https://docs.developer.yelp.com/llms.txt --- # Get Status Change Notifications Get status change notifications associated with a Yelp Checkout Order, ordered by most recent first. See [OrderStatusNotification](https://docs.developer.yelp.com/docs/resources#orderstatuschangenotification) resource for more info. [block:callout] { "type": "info", "body": "This endpoint is part of the Checkout API, visit [Checkout API](https://docs.developer.yelp.com/docs/checkout-api) to learn more." } [/block] # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Checkout API", "version": "1.0" }, "servers": [ { "url": "https://partner-api.yelp.com/checkout" } ], "security": [ { "basic": [] } ], "components": { "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } } }, "paths": { "/orders/{yelp_order_id}/update/v3": { "put": { "tags": [ "Checkout API" ], "summary": "Update Order", "operationId": "update_order", "description": "Update an existing Yelp Checkout Order by passing a Order object as the Partner wishes it to be.\n\nFields that cannot be updated: `yelp_order_id`, `service`, `billing_type`, `partner_business_id`, `collection_type`. These must be included as part of the Order object, but should match those passed when the order was created.\n\nThis operation is asynchronous, in that only basic sanity checking is done at the time the update request is submitted to Yelp, and, barring failure of those, the operation immediately returns an HTTP 200 response that includes the `yelp_order_id` and an `order_request_id`, which is a unique identifier for this partner request. Once submitted, Yelp will attempt to process this update request, including re-examining transactions associated with the order. The final success or failure of the operation is then delivered to the Partner by POSTing an `OrderStatusChangeNotification` to the `notification_url` provided at order creation time. This notification will include the matching `order_request_id` given to the Partner when the request was submitted.\n\nA Yelp Checkout Order may be updated before and after charges are made. However, only one update request may be outstanding at a time. That is, a Partner cannot submit a second update request before an `OrderStatusChangeNotification` is received for the first.\n\nOn every update call, all transactions on the Order are re-examined and possibly cancelled or replaced by up-to-date transactions.\n\nSee [Order](https://docs.developer.yelp.com/docs/resources#section-order) resource for more info.\n", "parameters": [ { "name": "yelp_order_id", "description": "ID of order that Yelp will try to update.", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "order": { "description": "Current complete (not a diff) Order as it should be after updates. See [Order Resource](https://docs.developer.yelp.com/docs/resources#section-order)", "type": "object" } } } } } }, "responses": { "200": { "description": "Successfully started the asynchronous process of updating an order.", "content": { "application/json": { "examples": { "Result": { "value": { "yelp_order_id": "e6efe441eb9aa321bab01bc28d9149ff", "order_request_id": "abc123" } } }, "schema": { "type": "object", "properties": { "yelp_order_id": { "type": "string" }, "order_request_id": { "type": "string" } } } } } }, "403": { "$ref": "#/paths/~1orders~1create~1v3/post/responses/403" }, "422": { "description": "This error is returned in any of the following scenarios:\n\n| Status | error_code | error_message (example)\n| ------- | ------------------------------- | ------------------------------\n| 422 | INVALID_ORDER_OPERATION\t | The order cannot be updated (either because it is cancelled or because another partner request is being processed)\n| 422\t | COLLECTION_TYPE_MUST_BE_PREPAID |\tIf the collection_type is passed as something other than `prepaid`\n", "content": { "application/json": { "$ref": "#/paths/~1orders~1create~1v3/post/responses/400/content/application~1json" } } }, "423": { "description": "This error is returned in any of the following scenarios:\n\n| Status | error_code | error_message (example)\n| ------- | ------------------------------- | ------------------------------\n| 423 | ORDER_NOT_READY_FOR_OPERATION |\tOrder is locked because another operation is in progress\n", "content": { "application/json": { "$ref": "#/paths/~1orders~1create~1v3/post/responses/400/content/application~1json" } } } } } }, "/orders/{yelp_order_id}/notifications/v3": { "get": { "tags": [ "Checkout API" ], "summary": "Get Status Change Notifications", "operationId": "get_status_change_notifications", "description": "Get status change notifications associated with a Yelp Checkout Order, ordered by most recent first.\n\nSee [OrderStatusNotification](https://docs.developer.yelp.com/docs/resources#orderstatuschangenotification) resource for more info.\n", "parameters": [ { "$ref": "#/paths/~1orders~1{yelp_order_id}~1update~1v3/put/parameters/0" }, { "name": "offset", "in": "query", "required": false, "description": "Pagination offset", "schema": { "type": "integer", "default": 0 } }, { "name": "limit", "in": "query", "required": false, "description": "Pagination limit", "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "Successfully retrieved order status notifications.", "content": { "application/json": { "examples": { "Result": { "value": { "offset": 100, "total_count": 125, "notifications": [ { "notification_id": "088c7c477ee66436f6e656c5740576f2", "yelp_order_id": "e6efe441eb9aa321bab01bc28d9149ff", "order_request_id": "abc123", "time_created": 1544465045, "order_status": "charge_pending" }, { "notification_id": "088c7c477ee66436f6e656c5740576f2", "yelp_order_id": "e6efe441eb9aa321bab01bc28d9149ff", "order_request_id": "abc123", "time_created": 1544465047, "order_status\"": "cancelled" } ] } } }, "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "total_count": { "type": "integer" }, "notifications": { "type": "array", "items": { "type": "object", "properties": { "notification_id": { "type": "string" }, "yelp_order_id": { "type": "string" }, "order_request_id": { "type": "string" }, "time_created": { "type": "integer" }, "order_status": { "type": "string" } } } } } } } } } } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": false, "samples-enabled": true }, "_id": { "buffer": { "0": 99, "1": 192, "2": 9, "3": 217, "4": 242, "5": 85, "6": 55, "7": 7, "8": 215, "9": 154, "10": 176, "11": 80 } } } ```