Order API
Order retrieve
Production endpoint:
https://transact.ti.com/v2/store/orders/
Retrieve information about your orders using the order retrieve API.
What you can do:
- See a list of your recent orders (defaults to the past 30 days).
- Get detailed information about a specific order by its order number.
Steps:
- Authentication: You will need your assigned API key and secret to authenticate with the API.
- API request: Send a request to the order API to get order status and additional details.
- API response: You will receive a response with a status code (200 OK) and a JSON containing order details.
- Filter orders by date (optional):
- To specify a date range, include the query paramaters “startDate” and “endDate” in your request.
- For example: https://transact.ti.com/v2/store/orders?startDate=2021-05-01&endDate=2025-05-31
- Retrieve specific order details:
- To get detailed information about a specific order, query the order API with the order number.
- For example: "https://transact.ti.com/v2/store/orders/T999999999"
Example request using order number:
curl --request GET \
--url 'https://transact.ti.com/v2/store/orders/{orderNumber}'
--header 'Authorization: Bearer {access_token}' \
Example response:
{
"orderNumber": 0,
"orderStatus": "string",
"customerPurchaseOrderNumber": "string",
"subTotal": 0,
"totalPrice": 0,
"lineItems": [
{
"tiPartNumber": "string",
"tiPartDescription": "string",
"quantity": "string",
"status": "string",
"unitPrice": 0,
"customReelIndicator": true
}
],
"shippingAddress": [
{
"addressType": "string",
"firstName": "string",
"lastName": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"town": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"email": "string",
"phoneNumber": "string",
"companyURL": "string"
}
],
"billingAddress": [
{
"addressType": "string",
"firstName": "string",
"lastName": "string",
"company": "string",
"addressLine1": "string",
"addressLine2": "string",
"town": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"email": "string",
"phoneNumber": "string",
"companyURL": "string"
}
],
"orderMessages": [
{
"code": "string",
"type": "string",
"Message": "string"
}
],
"customerOrderAttributes": [
{
"attribute": "string"
}
],
"orderPlacedTime": "string",
"paymentType": "string",
"currencyISO": "string",
"totalTax": 0,
"checkoutProfileIdentifier": "string",
"totalDeliveryCost": 0,
"totalDiscount": 0,
"couponCodes": "string"
}