Orders
These endpoints are still in development.
Properties
- Name
id- Type
- string
- Description
Unique identifier for the product.
- Name
external_id- Type
- string
- Description
The external id from the integration, e.g. Shopify, WooCommerce, Etsy, Squarespace, Square
- Name
customer_name- Type
- string
- Description
Name of the customer for the order.
- Name
customer_email- Type
- string
- Description
Email address for the order.
- Name
order_number- Type
- string
- Description
External order number.
- Name
is_paid- Type
- bool
- Description
Has the order been paid.
- Name
ordered_at- Type
- timestamp
- Description
Unix timestamp when the order was placed.
- Name
cancelled_at- Type
- timestamp
- Description
Unix timestamp when the order was cancelled.
- Name
refunded_at- Type
- timestamp
- Description
Unix timestamp when the order was refunded.
- Name
tags- Type
- array
- Description
Array of tags for the order.
- Name
gateways- Type
- array
- Description
Array of tags for gateways used on this order.
- Name
currency- Type
- string
- Description
Currency code for this order.
- Name
total- Type
- int
- Description
Total for the order in cents.
- Name
tax_total_shipping- Type
- int
- Description
Shipping tax total for the order in cents.
- Name
gateway_fee- Type
- int
- Description
Gateway fee that CollabPay has calculated, in cents.
- Name
total_discounts- Type
- int
- Description
Total discounts for the order in cents.
- Name
shipping_total- Type
- int
- Description
Shipping total for the order in cents.
- Name
discount_codes- Type
- array
- Description
Array of discount codes used.
- Name
customer_tags- Type
- array
- Description
Array of customer tags on the order.
- Name
ref- Type
- string
- Description
Affiliates reference - currently only used of Shopify orders.
- Name
created_at- Type
- timestamp
- Description
Unix timestamp of when the order was imported into CollabPay.
- Name
billing_address- Type
- object
- Description
Billing address
Properties
- Name
address_1- Type
- string
- Description
Address line one.
- Name
address_2- Type
- string
- Description
Address line two.
- Name
address_city- Type
- string
- Description
Address city.
- Name
address_company- Type
- string
- Description
Address company.
- Name
address_country- Type
- string
- Description
Address country.
- Name
address_country_code- Type
- string
- Description
Address country code.
- Name
address_first_name- Type
- string
- Description
First name of the address recipient.
- Name
address_last_name- Type
- string
- Description
Last name of the address recipient.
- Name
address_phone- Type
- string
- Description
Address phone number.
- Name
address_state- Type
- string
- Description
Address state.
- Name
address_state_code- Type
- string
- Description
Address state code.
- Name
address_zip- Type
- string
- Description
Address zip / postcode.
- Name
billing_address- Type
- object
- Description
Shipping address, same properties as billing address.
- Name
items- Type
- array
- Description
Array of order items.
Properties
- Name
external_id- Type
- string
- Description
External order item id.
- Name
amount- Type
- int
- Description
Amount for the item.
- Name
discount- Type
- int
- Description
Discount for the item.
- Name
quantity- Type
- int
- Description
Quantity.
- Name
tax_percent- Type
- decimal(4,2)
- Description
Tax percentage
- Name
tax_total- Type
- int
- Description
Total tax for this line item.
- Name
tax_name- Type
- string
- Description
Name of the tax.
- Name
grams- Type
- int
- Description
Grams for this item.
- Name
split_at- Type
- int
- Description
Unix timestamp when this item was split.
- Name
refunded_at- Type
- int
- Description
Unix timestamp when this item was refunded.
- Name
order- Type
- order
- Description
- Order object
- Name
product- Type
- product
- Description
- Product object