Papaya Open API - V1

Server

Production

Client Libraries

Shell Curl

Channel (Collapsed)

Represents an ordering channel such as dine-in, takeaway, or third-party delivery.

Channel Operations

get/api/v1/channels

Order (Collapsed)

Represents a customer order, including order items, pricing breakdown, taxes, tips, payment methods, and order status updates.

Order Operations

get/api/v1/orders/action-logs
get/api/v1/orders/{id}/action-log
get/api/v1/orders
post/api/v1/orders
post/api/v1/orders/import
get/api/v1/orders/{id}
put/api/v1/orders/{id}
post/api/v1/orders/reservations
put/api/v1/orders/reservations/{id}

Outlet (Collapsed)

Represents a merchant outlet or store location, including its name, status, branding, address, contact info, business hours, and country/currency settings.

Outlet Operations

get/api/v1/outlets
get/api/v1/outlets/{id}

Inventory (Collapsed)

Represents a merchant's ingredient inventory, including inventory products, suppliers, and goods receipts that record stock movements.

Inventory Operations

get/api/v1/inventory/products
get/api/v1/inventory/suppliers
get/api/v1/inventory/suppliers/{supplierId}/invoiced-items
get/api/v1/inventory/goods-receipts
post/api/v1/inventory/goods-receipts

Webhooks (Collapsed)

Webhooks Webhooks

postChannels Published
postMenu Published
postOrder status
postOutlet Updated
postReservation Order Update