Skip to main content
Plato APIs return JSON error messages where possible.

Error Shape

REST endpoints usually return one of these shapes:
Log the HTTP status, response body, and request id when a REST request fails.

Common Status Codes

Pagination Limits

Different APIs expose different pagination styles. CMS list endpoints use:
Menu endpoints use:
Connect360 list operations use cursors:

Order Feed Limits

The restaurant order feed returns up to 50 orders per request. Date ranges can be up to 5 days when both date and endDate are provided.

Retry Guidance

Retry only when the failure is temporary. Retry:
  • Network timeouts.
  • 429 after waiting.
  • 500 or 503 after a short delay.
Do not retry until fixed:
  • Invalid API key.
  • Missing permission.
  • Unknown field.
  • Required field missing.
  • Invalid relation id.

Idempotency

Aggregator order creation is idempotent by aggregator and externalOrderId, and also accepts an Idempotency-Key header. See Idempotency And Errors. Other write operations like CMS create, form submit, and message send can create new records every time they are called. Make your own integration idempotent when duplicate submissions are possible.