loading

Step 4: Retrieve Add Request

Our request for adding service to a new Location has gone into processing. To check on the status of that request, you can make the below call:

GET https://api.yext.com/v2/accounts/me/addrequests/{addRequestId}?api_key=API_KEY&v=YYYYMMDD

Response Body:

{
	"meta": {
		"uuid": "821042ea-5f0e-4aa8-95aa-ab52b89edf9f",
		"errors": []
	},
	"response": {
		"id": 204095,
		"locationMode": "new",
		"skus": ["SKU-00000275"],
		"agreementId": 878,
		"status": "Complete",
		"dateSubmitted": "2017-01-12T17:36:24",
		"dateCompleted": "2017-01-12T17:36:25",
		"statusDetail": "The request was completed and the specified services were started. Account ID BCC-6364487045 was created by this request. Location ID BCC-6364487045 was created in this request."
	}
}

The response will indicate if there are any issues with your request. Yext can block Add Service requests for various reasons, such as missing or invalid data or duplicate Locations.

For more information, see the documentation for the Add Requests: List endpoint.

You can also retrieve a list of all add requests by removing the addRequestId parameter from the call. This endpoint also allows you to do some filtering of these results based on a series of query parameters. For example:

GET https://api.yext.com/v2/accounts/me/addrequests?api_key=API_KEY&v=YYYYMMDD

Response Body:

{
  "meta": {
    "uuid": "2c23855c-a8b2-4042-bcbc-03d8715f0dae",
    "errors": []
  },
  "response": {
    "addRequests": [
      {
        "id": 204104,
        "locationMode": "existing",
        "skus": [
          "SKU-00000309"
        ],
        "agreementId": 878,
        "status": "Complete",
        "dateSubmitted": "2017-01-13T16:44:37",
        "dateCompleted": "2017-01-13T16:44:37",
        "statusDetail": "The request was completed and the specified services were started."
      },
      {
        "id": 204096,
        "locationMode": "new",
        "skus": [
          "SKU-00000275"
        ],
        "agreementId": 878,
        "status": "Review",
        "dateSubmitted": "2017-01-12T19:28:42",
        "dateCompleted": "",
        "statusDetail": "Yext is reviewing this request to ensure that the specified location does not already have incompatible service in another account. You do not need to take any action."
      },
      {
        "id": 204095,
        "locationMode": "new",
        "skus": [
          "SKU-00000275"
        ],
        "agreementId": 878,
        "status": "Complete",
        "dateSubmitted": "2017-01-12T17:36:24",
        "dateCompleted": "2017-01-12T17:36:25",
        "statusDetail": "The request was completed and the specified services were started. Account ID BCC-6364487045 was created by this request. Location ID BCC-6364487045 was created in this request."
      }
    ],
    "count": 3
  }
}

For more information, see the documentation for the Add Requests: Get endpoint.

Splash Loading