Hang Platform
  • Introduction
  • Hang Embed
  • Webhooks
    • Use incoming webhooks to get real-time updates
    • Types of events
    • quest_opt_in.updated
    • program_membership.created
    • program_membership.updated
  • API Usage
    • Creating Program Memberships for New Users
    • Search for a program membership
    • Updating Program Memberships for Existing Users
    • Record Activities on a Program Membership
    • Update Traits on a Program Membership
    • Fetching and Opening Loot Boxes for a Program Membership
    • Managing Quests for Program Memberships
    • Managing Redemptions for Program Memberships
    • Retrieving Rewards for Program Memberships
    • Creating and Managing Puzzles
    • Checking applicable Rewards for a Toast cart
    • Posting Orders Through Hang
    • Search for a PartnerApiOrder
    • Retrieving Created or Updated Program Memberships
  • API
    • Overview
    • About
    • API reference
      • Membership
        • Social media credentials
        • Wallets
      • Program memberships
        • Activities
        • Add trait
        • Remove trait
        • Set image
        • Search
        • Level
        • Opt ins
        • Redemptions
        • Rewards
        • Applicable rewards
        • Balance cards
          • Deposit
          • Reverse transaction
        • Loot boxes
          • Open
        • Puzzles
          • Complete
        • Activies
          • Synchronous
        • Quests
          • Opt ins
          • Opt in
      • Users
      • Integrations
        • Search
      • Programs
        • Tiers
      • Admin
        • Program
        • Quests
          • Quest requirements
        • Quest requirements
        • Rewards
          • Batch create
          • Batch update
        • Bingo games
          • Bingo tasks
            • Bulk update
        • Challenges
          • Update status
          • Streak config info
          • Settings config info
        • Integrations
          • Square
            • Disconnect
        • Loot box reward choices
        • Loot box reward probabilities
        • Loot boxes
        • Program memberships
          • Bonus rewards
          • Program and tier rewards
          • Activity history
          • Quest activities
          • Program segments
          • Member actions
            • Grant reward
            • Grant loot box
            • Grant points
            • Activity
        • Program memberships
        • Program segments
          • Members
        • Program stripe accounts
          • Create
        • Program tiers
        • Promotions
        • Puzzle pieces
        • Puzzles
        • Toast takeout orders
          • Refund
      • Opt ins
        • Claim quest prize
        • Claim activity prize
      • Wallets
        • Redemptions
        • Tokens
      • Redemptions
        • Redeem
      • Tokenized rewards
        • Burn
        • Contracts
          • Wallets
      • Tokens
        • Add trait
        • Remove trait
        • Set token image
        • Level
        • Loot boxes
          • Open
      • External
        • Orders
    • Specification
Powered by GitBook
On this page
  1. API
  2. API reference
  3. External

Orders

PreviousExternal

Create an Order record.

post

This endpoint receives orders from external systems. It requires a comprehensive payload that includes details about the order, such as the items purchased, applicable taxes, discounts, and the source and POS system of the order. It can optionally link the order to a program membership if the program_membership_id is provided.

Authorizations
Body
payload[order][line_items]arrayRequired

Line items in the order

payload[order][amount]numberRequired

Total amount of the order in cents

payload[order_source]stringRequired

Source of the order.

payload[type]stringRequired

What type of transaction occurred.

payload[merchant_pos_system]stringRequired

Type of POS system from which the order originates.

payload[external_order_guid]stringRequired

Unique identifier for the order from the external system.

payload[external_location_type]stringRequired

Type of the external location (e.g., ToastRestaurant).

payload[external_location_id]stringRequired

Unique identifier for the location from the external system (e.g., a restaurant ID from Toast).

payload[program_membership_id]stringOptional

Program membership ID if available. Nullable field to tie the order to a specific membership.

payload[external_customer_id]stringOptional

External customer ID associated with the order.

payload[order][applied_discounts]arrayOptional

List of reward IDs applied to the transaction as a whole

Responses
post
POST /partner-api/v2/external/orders HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 388

"payload[order][line_items]=[]&payload[order][amount]=1&payload[order_source]='text'&payload[type]='text'&payload[merchant_pos_system]='text'&payload[external_order_guid]='text'&payload[external_location_type]='text'&payload[external_location_id]='text'&payload[program_membership_id]='text'&payload[external_customer_id]='text'&payload[order][applied_discounts]=[]"
200

ok

No content