Get Order Transactions

Function

Get order transactions of POS orders by orderIds. A maximum of 100 unique orderIds can be requested per request.

URL

GET <<api_domain>>/v1/orders/transactions?orderIds[]=orderId1&orderIds[]=orderId2

Request Example

curl --request GET \
     --url https://open.shopline.io/v1/orders/transactions?orderIds[]=6214b5979fdc3f483815c361&orderIds[]=6214b5979fdc3f483815c362\
     --header 'Accept: application/json'
     --header 'Authorization: Bearer access_token' \

Request Parameters

Parameter	Type	Description	Example
orderIds *Required	`Array`	Order IDs 訂單IDs	`['621367dcdfd9108735542dad']`

Request Response

Field	Type	Description
id	String	BSON ObjectId
tax_id	String	Uni business number
invoice_cancelled_at	String	invoice cancelled timestamp
transaction_number	String	Transaction number
created_at	String	Transaction CreatedAt
payments	Array	Transaction payments
invoice_number	Array	invoices of the transaction
agent	Hash	Transaction Agent
order_number	String	order number
note	String	Transaction Note

Response Example

{
    "items": [
        {
            "invoice_date": null,
            "tax_id": null,
            "invoice_cancelled_at": "2022-02-21T10:22:42.124+00:00",
            "transaction_number": "8342236707374992422",
            "created_at": "2022-02-21T10:22:42.124Z",
            "payments": [
                {
                    "id": "612ca0ff383d253c60191764",
                    "instructions_translations": null,
                    "name_translations": {
                        "ms": "",
                        "fr": "",
                        "de": "",
                        "ja": "",
                        "vi": "",
                        "zh-hant": "現金",
                        "zh-cn": "",
                        "th": "",
                        "en": "Cash",
                        "id": ""
                    },
                    "type": "cash",
                    "amount": {
                        "cents": -666,
                        "currency_iso": "TWD",
                        "dollars": -666
                    }
                }
            ],
            "invoice_number": [],
            "agent": {
                "id": "612ca400c4d3240044197654",
                "email": "[email protected]",
                "name": "Vivian",
                "phone": "0988321312",
                "status": "active"
            },
            "order_number": "20220221102223562",
            "note": ""
        },
        {
            "invoice_date": "2022-02-21T10:22:24.071Z",
            "tax_id": "",
            "invoice_cancelled_at": "2022-02-21T10:22:42.124+00:00",
            "transaction_number": "2740297464418634857",
            "created_at": "2022-02-21T10:22:23.603Z",
            "payments": [
                {
                    "id": "612ca0ff383d253c60191764",
                    "instructions_translations": null,
                    "name_translations": {
                        "zh-hant": "現金",
                        "fr": "",
                        "de": "",
                        "vi": "",
                        "ms": "",
                        "id": "",
                        "ja": "",
                        "th": "",
                        "zh-cn": "",
                        "en": "Cash"
                    },
                    "type": "cash",
                    "amount": {
                        "cents": 666,
                        "currency_iso": "TWD",
                        "dollars": 666
                    }
                }
            ],
            "invoice_number": [
                "VT02504002"
            ],
            "agent": {
                "id": "617241c308d990004b4542e6",
                "email": "",
                "name": "AAA",
                "phone": "",
                "status": "active"
            },
            "order_number": "20220221102223562",
            "note": ""
        }
    ]
}