Peach
  1. orders
Peach
  • messaging
    • Send a pre-approved template message
      POST
    • Poll template message status
      GET
    • Launch a broadcast
      POST
    • Poll broadcast status
      GET
    • Poll template messages status
      GET
    • Connect to AI Agent
      POST
    • Send an App message
      POST
  • whatsapp_templates
    • List all templates
      GET
    • Create a template
      POST
    • Update template
      PATCH
    • Archive template
      PATCH
    • Pause template
      PATCH
    • Submit template
      PATCH
  • conversations
    • Agent Assignment
      POST
    • Close Conversation
      POST
  • contacts
    • Create a contact
      POST
    • Update a contact
      PATCH
    • Create multiple contacts
      POST
  • orders
    • Create an order
      POST
    • Find order by ID
      GET
    • Create a refund for an order
      POST
  • medias
    • About uploaded media
    • List available medias
      GET
    • Add a media
      POST
    • Remove a media
      DELETE
  • webhooks
    • Order status webhooks
    • Flow execution status webhooks
    • Message delivery status webhooks
    • AI Agent Execution Webhooks
  • Schemas
    • Schemas
      • Order
      • RefundRequest
      • Contact
      • LineItem
      • OrderExpiry
      • TemplateMessage
      • AnyValue
      • Argument
  1. orders

Find order by ID

GET
/api/v1/orders/{orderId}
Fetch details of an order

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/orders/' \
--header 'Authorization: <api-key>'

Responses

🟢200OK
application/json
Body

Example
{
    "id": "wa_ord_1234abcd",
    "status": "pending",
    "reference_id": "ext_ord_1245",
    "external_id": "ext_ord_1245",
    "product_type": "digital_goods",
    "subtotal": 20000,
    "tax": 0,
    "tax_description": null,
    "shipping": 0,
    "shipping_description": null,
    "discount": 0,
    "discount_description": null,
    "total_amount": 20000,
    "expiration": "2025-11-29T05:40:02.559Z",
    "expiration_description": null,
    "contact": {
        "phone_number": "+919988776655",
        "name": "John Doe"
    },
    "items": [
        {
            "id": 1,
            "product_id": 1,
            "name": "Product 1",
            "quantity": 1,
            "amount": 10000,
            "sale_amount": 10000,
            "currency": null
        },
        {
            "id": 2,
            "product_id": 3,
            "name": "Product 2",
            "quantity": 1,
            "amount": 10000,
            "sale_amount": 10000,
            "currency": null
        }
    ],
    "created_at": "2025-11-28T05:40:02.593Z",
    "updated_at": "2025-11-28T05:40:02.593Z"
}
🟠404Record Not Found
Modified at 2025-11-28 05:27:16
Previous
Create an order
Next
Create a refund for an order
Built with