Orders

Allow convertedin to get your orders

These keys are specified to use as defined in docs, they are case-sensitive. Any change in these keys may cause issues during data sync

Authentication

Use your token provided inside converted.in after on boarding process to authenticate the request using form-data body

Get orders

POST YOUR_BASEURL/convertedin/orders

Request Body

Name	Type	Description
per_page*	integer	limit per page (default 100)
page*	integer	page number
token*	string

200

{
    "current_page": 1,
    "data": [
        {
            "id": 101905,
            "ordered_at": "2020-12-02 14:42:29.000000",
            "total_price": 350, 
            "subtotal_price": 300,
            "total_tax": 0,
            "taxes_included": 0,
            "currency": "EGP",
            "country_code": "CA",
            "financial_status": "processing", // order status, (successful, canceled, etc...) your own statuses
            "total_discounts": 0,
            "phone": "01226699662",
            "customer_locale": null, // en, ar
            "contact_email": "[e-mail]", 
            "line_items" : [
                {
                    "product_id": 324,
                    "quantity": 2,
                    "price": 50
                }
            ]
        }
    ],
    "from": 1,
    "last_page": 30,
    "per_page": 100,
    "to": 100,
    "total": 3000
}

key	Description	Validation Rule
id	Unique identifier for order	Required
ordered_at	Order date, Format: Y-m-d H:i:s, ex: 2020-12-15 19:00:00	Required
total_price	Order total payment by customer, decimal	Required
subtotal_price	Order subtotal / goods price,, decimal	Required
total_tax	Order taxes, decimal default 0	Required
taxes_included	Is taxes included (0, 1)	Required
currency	Order currency in ISO code (USD, EUR, etc...)	Required
country_code	Client country code in ISO code (US, GB)	Required
financial_status	Order status (processing, successful, canceled, refunded)	Not required
total_discounts	Order discount, decimal default 0	Required
phone	Client phone	Required
customer_locale		Not Required
contact_email		Required
line_items	items array as shown in response example	Required
customer	link order with id inside customer object ex: "customer": { "id": 207119551 }	Required

Response

{
    "data": [
        {
            "id": 450789469,
            "closed_at": null,
            "confirmed": true,
            "contact_email": "[e-mail]",
            "created_at": "2008-01-10T11:00:00-05:00",
            "currency": "USD",
            "customer_locale": null,
            "discount_codes": [
                {
                    "code": "TENOFF",
                    "amount": "10.00",
                    "type": "fixed_amount"
                }
            ],
            "email": "[e-mail]",
            "financial_status": "partially_refunded",
            "fulfillment_status": null,
            "landing_site": "http://www.example.com?source=abc",
            "landing_site_ref": "abc",
            "name": "#1001",
            "note": null,
            "number": 1,
            "order_number": 1001,
            "order_status_url": "https://apple.myshopify.com/690933842/orders/b1946ac92492d2347c6235b4d2611184/authenticate?key=imasecretipod",
            "payment_gateway_names": [
                "bogus"
            ],
            "phone": "[phone]",
            "presentment_currency": "USD",
            "processed_at": "2008-01-10T11:00:00-05:00",
            "processing_method": "direct",
            "reference": "fhwdgads",
            "referring_site": "http://www.otherexample.com",
            "source_identifier": "fhwdgads",
            "source_name": "web",
            "source_url": null,
            "subtotal_price": "597.00",
            "tags": "",
            "taxes_included": false,
            "total_discounts": "10.00",
            "total_line_items_price": "597.00",
            "total_price": "598.94",
            "total_price_usd": "598.94",
            "total_tax": "11.94",
            "total_tip_received": "0.00",
            "total_weight": 0,
            "updated_at": "2008-01-10T11:00:00-05:00",
            "billing_address": {
                "first_name": "Bob",
                "address1": "Chestnut Street 92",
                "phone": "555-625-1199",
                "city": "Louisville",
                "zip": "40202",
                "province": "Kentucky",
                "country": "United States",
                "last_name": "Norman",
                "address2": "",
                "company": null,
                "latitude": 45.41634,
                "longitude": -75.6868,
                "name": "Bob Norman",
                "country_code": "US",
                "province_code": "KY"
            },
            "customer": {
                "id": 207119551,
                "email": "[e-mail]",
                "accepts_marketing": false,
                "created_at": "2021-10-01T17:01:53-04:00",
                "updated_at": "2021-10-01T17:01:53-04:00",
                "first_name": "Bob",
                "last_name": "Norman",
                "orders_count": 1,
                "state": "disabled",
                "total_spent": "199.65",
                "last_order_id": 450789469,
                "note": null,
                "verified_email": true,
                "multipass_identifier": null,
                "tax_exempt": false,
                "phone": "[phone]",
                "tags": "",
                "last_order_name": "#1001",
                "currency": "USD",
                "accepts_marketing_updated_at": "2005-06-12T11:57:11-04:00",
                "marketing_opt_in_level": null,
                "tax_exemptions": [],
                "admin_graphql_api_id": "gid://shopify/Customer/207119551",
                "default_address": {
                    "id": 207119551,
                    "customer_id": 207119551,
                    "first_name": null,
                    "last_name": null,
                    "company": null,
                    "address1": "Chestnut Street 92",
                    "address2": "",
                    "city": "Louisville",
                    "province": "Kentucky",
                    "country": "United States",
                    "zip": "40202",
                    "phone": "555-625-1199",
                    "name": "",
                    "province_code": "KY",
                    "country_code": "US",
                    "country_name": "United States",
                    "default": true
                }
            },
            "line_items": [
                {
                    "id": 466157049,
                    "fulfillable_quantity": 0,
                    "fulfillment_status": null,
                    "name": "IPod Nano - 8gb - green",
                    "price": "199.00",
                    "product_exists": true,
                    "product_id": 632910392,
                    "quantity": 1,
                    "title": "IPod Nano - 8gb",
                    "total_discount": "0.00",
                    "variant_id": 39072856,
                    "variant_title": "green",
                    "vendor": null
                }
            ]
        }
    ],
    "total": 1000,
    "per_page": 100,
    "current_page": 1,
    "last_page": 10,
    "from": 1,
    "to": 100
}