Once you know how to make requests through Inkthreadable's API, you'll need to know the order property values used to create and process orders:
Order Properties
id - readonly
{"id": "23941"}A unique numeric identifier for the order used by the shop owner and customer.
external_id - writeable
{"external_id": "TEST-234324"}A unique numeric identifier for the internal customer order.
created_at - readonly
{"created_at": "2016-10-17T15:07:08+01:00"}By default, this auto-generated property is the date and time when the order was created in Inkthreadable, in ISO 8601 format.
type - readonly
{"type": "order"}order - regular order
invoice - generate invoice for current account balance
credits - credit purchase
status - readonly
{"status": "received"}received
in progress
paid
stock allocation
printing
quality control
refunded
internal order query
deleted - readonly
{"deleted": "false"}If the order was cancelled, this value is "true".
brand - writable
{"brand": "Inkthreadable"}The name of one of the brands created on your Brand page.
billing_address - writable
{"billing_address": {
"firstName": "Maxim",
"lastName": "Shkolyarenko",
"company": "Brickweb",
"address1": "The Gatehouse",
"address2": "Daisyfield Mill",
"city": "Blackburn",
"county": "Lancashire",
"postcode": "BB1 3BL",
"country": "United Kingdom",
"phone1": "+44 (0)1254 277190",
"phone2": "",
"phone3": "",
"vatNumber": ""
}}This value is the billing address associated with the creator account. The property is generated based on your profile details and has the following properties:
address1: The street address of the billing address.
address2: An optional additional field for the street address of the billing address.
city: The city of the billing address.
company: The company of the person associated with the billing address.
country: The name of the country of the billing address.
firstName: The first name of the person associated with the payment method.
lastName: The last name of the person associated with the payment method.
phone1: The phone number at the billing address.
phone2: The mobile number at the billing address.
phone3: The fax number at the billing address.
county: The name of the state or province of the billing address.
postcode: The zip or postal code of the billing address.
vatNumber: The VAT number of the billing address.
shipping_address - writable
{"shipping_address": {
"firstName": "Maxim",
"lastName": "Shkolyarenko",
"company": "Brickweb",
"address1": "The Gatehouse",
"address2": "Daisyfield Mill",
"city": "Blackburn",
"county": "Lancashire",
"postcode": "BB1 3BL",
"country": "United Kingdom",
"phone1": "+44 (0)1254 277190",
"phone2": "",
"phone3": "",
"vatNumber": ""
}}The shipping address where the order will be shipped to. It has the following properties:
address1: The street address of the shipping address.
address2: An optional additional field for the street address of the shipping address.
city: The city of the shipping address.
company: The company of the person associated with the shipping address.
country: The name of the country of the shipping address.
firstName: The first name of the person associated with the payment method.
lastName: The last name of the person associated with the payment method.
phone1: The phone number at the shipping address.
phone2: The mobile number at the shipping address.
phone3: The fax number at the shipping address.
county: The name of the state or province of the shipping address.
postcode: The zip or postal code of the shipping address.
items - writable
"items": [
{
"pn": "JH001",
"title": "AWDis Girlie College Hoodie",
"price": "23.25",
"retailPrice": "20.00",
"quantity": "4",
"description": "Special instructions",
"label": {
"type": "printed",
"name": "max-label",
"price": 1.44,
}
"designs": [
"back": "url",
"front": "url",
...
],
"mockups":[
"back": "url",
"front": "url",
...
]
}
]
A list of line item objects, each one containing information about an item in the order. Each item object has the following properties:
pn: The product code of the product variant.
title: The title of the product. (readonly)
price: The price of the item with applied discounts. (readonly)
retailPrice: The retail price of the item (printed on invoice that will be sent to customer with order).
quantity: The number of products that were purchased.
description: Comments or instructions for the product.
label: The label details.
type: The label type - "printed".
name: The name of one of the labels created on your Brand Profile. (readonly)
price: The price of the label.
designs: A list of designs for print, each one containing information about a side of printing and link to file for printing.
mockup: A list of mockups, each one containing information about a side name and link to mockup file.
summary - readonly
"summary": {
"currency": "GBP",
"subtotalPrice": "93.00",
"shippingPrice": "7.20",
"total": "100.20",
"totalTax": "16.70"
}Information relating to the order summary. It has the following properties:
currency: The three letter code (ISO 4217) for the currency.
subtotalPrice: Price of the order before shipping and taxes.
shippingPrice: The price of the shipping method.
total: The sum of costs of all items in the order, taxes and discounts included.
totalTax: The amount of tax to be charged.
shipping - writable
"shipping": {
"shippingMethod": "courier",
"trackingNumber": "TF345435",
"shiped_at": "2016-10-17T16:17:08+01:00"
}The shipping details. It has the following properties:
shippingMethod: A reference to the carrier service that provided the rate. Can be one of the following three values;
regular: Standard delivery;
recorded: Recorded delivery;
courier: Courier delivery.
trackingNumber: The tracking number provided by the courier. (readonly)
shiped_at: The date and time when fulfilled. The API returns this value in ISO 8601 format. (readonly)
payment - readonly
"payment": {
"methodMethod": "Pay by Credit or Debit Card",
"paid_at": "2016-10-17T16:14:08+01:00"
}An object containing information about the payment status. It has the following properties:
methodMethod: The name of the gateway the transaction was issued through.
paid_at: The date and time when the transaction was created. The API returns this value in ISO 8601 format.
What's next?
Learn what endpoint values are returned after submitting requests to Inkthreadable's API.