Get an order

Developing

GET

https://app.duoplane.com/api/orders/{id}

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://app.duoplane.com/api/orders/' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200Success

application/json

Body

Example

{
    "metadata": {},
    "data": {
        "id": 0,
        "type": "order",
        "attributes": {
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "store_id": 0,
            "store_source_name": "string",
            "internal_id": "string",
            "external_id": "string",
            "ordered_at": "2019-08-24T14:15:22Z",
            "tag_names": [
                "string"
            ],
            "customer_note": "string",
            "order_notes": [
                {
                    "title": "string",
                    "body": "string"
                }
            ]
        },
        "relationships": {
            "order_items": [
                {
                    "id": "string",
                    "type": "order_item",
                    "attributes": {
                        "name": "string",
                        "quantity": 0,
                        "price": 0,
                        "cost": 0,
                        "retailer_product_id": 0,
                        "retailer_sku": "string",
                        "internal_id": "string",
                        "vendor_sku": "string",
                        "upc": "string",
                        "mpn": "string",
                        "other_barcode": "string",
                        "order_item_notes": [
                            {
                                "title": "string",
                                "body": "string"
                            }
                        ]
                    },
                    "relationships": [
                        {}
                    ]
                }
            ],
            "shipping_address": {
                "id": "string",
                "type": "address",
                "attributes": {
                    "first_name": "string",
                    "last_name": "string",
                    "company_name": "string",
                    "address_1": "string",
                    "address_2": "string",
                    "city": "string",
                    "post_code": "string",
                    "province_name": "string",
                    "province_code": "string",
                    "country_name": "string",
                    "country_iso2": "string",
                    "phone": "string",
                    "email": "user@example.com"
                }
            },
            "billing_address": {
                "id": "string",
                "type": "address",
                "attributes": {
                    "first_name": "string",
                    "last_name": "string",
                    "company_name": "string",
                    "address_1": "string",
                    "address_2": "string",
                    "city": "string",
                    "post_code": "string",
                    "province_name": "string",
                    "province_code": "string",
                    "country_name": "string",
                    "country_iso2": "string",
                    "phone": "string",
                    "email": "user@example.com"
                }
            }
        }
    },
    "errors": [
        "string"
    ]
}

Modified at 2024-10-03 01:44:39

Create an order

The Product object