menus_endpoints

Notify the result of a Publish Menu event

Successful callback response for the publish menu webhook. If an error occurred, please publish a callback error instead. See failed event flow for details. Rate limit: 8 requests per minute.

post/v1/menus/publish

Request

Headers

X-Store-Idstring required

The unique identifier of the store in your app. This ID, along with the Application ID, will be used to match the correct store when performing operations. It cannot be longer than 255 characters and must only contain printable ASCII characters. During on-boarding, this ID will be similar to onboarding:905bb725-b141-4a9b-832a-1f254f772c94 (where the UUID is the Internal Store ID). During off-boarding, this field will be filled with the last known Store ID, or with an empty string, in case none is found. In that case, please fall back to the provided internalStoreId (a.k.a. Sku-Sku ID).

Example:partner-store-unique-identifier
X-Event-Idstring required

Unique identifier of the event that this callback refers to.

Example:cf0ce51b-d74e-40d3-b177-1925ab4edc0c

Request body

requestedToCreatedEntityIdsobject required

A map for entities created by the Upsert containing the IDs of the requested entities mapped to the IDs of entities created by the request. Our system will use the IDs returned in this map to send updates to these entities in future requests. NOTE - A empty map can be used on requestedToCreatedEntityIds to use the same menu IDs that were previously defined.

Example request

{
  "requestedToCreatedEntityIds": {
    "1ecd8573-c033-4a55-9d69-4e99bb0397b4": "ABCDEFGHIJK1234"
  }
}

Response

The Publish menu event result was successfully processed

Changes

No recorded changes to this operation across all 1 revision of this API.