Skip to main content

Set the order source

PUT 
/order-source

Registers your application as an order source, or changes it. Each application has one source per merchant. Send it once per merchant, before the first POST /orders.

Behaviour​

  • The first call answers 201; a later call answers 200 and can change display_name at any time.
  • It works for the whole merchant, so it needs no X-Outlet-ID, no X-User-ID and no Idempotency-Key: sending the same body again changes nothing.
  • The first call also creates the payment method that POS records your paid orders on, named Paid on <display_name>.
  • The merchant does not see it in the payment method list, and it does not use one of the merchant's custom payment method places.

Errors​

StatusCodeWhen
400VALIDATION_FAILEDsource_code or display_name is missing or invalid, or source_code is a reserved word.
401COMPANY_NOT_FOUNDThe company is not found.
403PLAN_FEATURE_REQUIREDThe merchant's plan does not include the Public API add-on. This answer has no data.
403SUBSCRIPTION_EXPIREDThe subscription has expired.
409SOURCE_CODE_TAKENAnother application of the same merchant uses this source_code.
409SOURCE_CODE_LOCKEDThe source already has an order, so its source_code can no longer change.

Request​

Responses​

The source already existed and was updated; same body as 201.