Duoplane API
  1. Order schemas
Duoplane API
  • Duoplane API overview
    • Access and authentication
    • Request and response basics
    • Rate limiting
  • API reference
    • Order management
      • Orders
        • The Order object
        • Create an order
        • Get an order
    • Product and inventory management
      • Products
        • The Product object
        • Create a product
        • Get a single product
      • Product Inventories
        • The ProductInventory object
  • Schemas
    • Order schemas
      • Address object
      • Address attributes
      • Order object
      • Order attributes
      • OrderItem object
      • OrderItem attributes
      • Note attributes
      • Shipment object
      • Shipment attributes
      • ShipmentItem attributes
      • ShipmentItem object
    • Product schemas
      • Product object
      • Product attributes
      • ProductInventory object
      • ProductInventory attributes
      • Product identifiers
    • Shared schema
      • Timestamps
      • Object template
      • API response
    • Reponse metadata
  1. Order schemas

Order object

{
    "id": 0,
    "type": "order",
    "attributes": {
        "store_id": 0,
        "store_source_name": "string",
        "internal_id": "string",
        "external_id": "string",
        "ordered_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "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"
            }
        }
    }
}
Built with