For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGuidesAPI Reference
HomeGuidesAPI Reference
  • Online API
    • API Environments
    • Direct Payment Flow
    • REST
    • HTTPS
    • Dates
    • Pagination
    • Authentication
    • Idempotent Requests
    • Timeouts
    • API Simulator
  • Models
    • Introduction
    • Contact Object
    • Consumer Object
    • Discount Object
    • Item Object
    • Money Object
    • Order Details Object
    • Payment Object
    • Refund Object
    • Shipping Courier Object
  • Service Status
    • GETPing
  • Configuration
    • GETGet Configuration
  • Orders
    • Introduction
    • GETGet Order
    • POSTCreate Order
  • Javascript afterpay.js
    • Information
    • Redirect Method
  • Payments
    • Introduction
    • POSTCapture Payment
    • PUTUpdate Shipping Courier
    • GETGet Payment By Order ID
    • GETGet Payment By Token
    • GETList Payment(s)
    • POSTCreate Refund
    • PUTUpdate Payment by Order ID
    • POSTReverse Payment By Token
  • Errors
    • Introduction
    • Get Errors
    • Put/Post Errors
  • Reference
LogoLogo
On this page
  • Attributes
  • Example Item object
  • Australia
  • New Zealand
  • United States of America
Models

Item object

Was this page helpful?
Previous

Money Object

Next
Built with

Attributes

AttributeTypeDescription
namestring requiredProduct name. Limited to 255 characters.
skustringProduct SKU. Limited to 128 characters.
quantityinteger requiredThe quantity of the item, stored as a signed 32-bit integer.
priceMoney requiredThe unit price of the individual item. Must be a positive value.

Example Item object

Australia

1{
2 "name": "T-Shirt",
3 "sku": "12341234",
4 "quantity": 1,
5 "price": {
6 "amount": "10.00",
7 "currency": "AUD"
8 }
9}

New Zealand

1{
2 "name": "T-Shirt",
3 "sku": "12341234",
4 "quantity": 1,
5 "price": {
6 "amount": "10.00",
7 "currency": "NZD"
8 }
9}

United States of America

1{
2 "name": "T-Shirt",
3 "sku": "12341234",
4 "quantity": 1,
5 "price": {
6 "amount": "10.00",
7 "currency": "USD"
8 }
9}