Docs

Docs / FFL Checkout / FFL orders

For FFL Checkout stores
Endpoint · Report that the transfer happened

POST/ffl-orders/{ref}/complete

Mark an FFL order completed once the transfer has happened. Its dealer is then on file with your store. Safe to repeat.

Needs FFL orders: Read and writeBase URL https://backend.fflmonkey.com/api/v1Counts 1 toward 120 a minute

Fields

Only the order number, in the address: the ref you reported the order with. Needs FFL orders: Read and write, a permission of FFL Checkout stores.

  • Send it once the transfer has happened. The order is marked completed and announced as ffl_order.completed, and its dealer is then on file with your store: later searches say on_file true.
  • Safe to repeat. An order completed already is answered as it is, and nothing is announced again.
  • An order never reported is created, completed: the report may have been lost. It has no dealer then.
  • The order number in the path follows the same rules as a reported ref: up to 64 letters, digits, dots, underscores, colons and hyphens, never a WooCommerce order key.

Returns

This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.

Example

FFL Monkey FFL Checkout API, version 1. Questions: Support in your FFL Monkey account, or [email protected].