Duoplane API
  1. Orders
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
          POST
        • Get an order
          GET
    • Product and inventory management
      • Products
        • The Product object
        • Create a product
        • Get a single product
      • Product Inventories
        • The ProductInventory object
  1. Orders

Create an order

Developing
POST
https://app.duoplane.com/api/orders

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 *****************
Body Params application/json

Example
{
    "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"
        }
    ],
    "shipping_address": {
        "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": {
        "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"
    },
    "order_items": [
        {
            "name": "string",
            "quantity": 0,
            "price": 0,
            "retailer_product_id": 0,
            "retailer_sku": "string",
            "internal_id": "string",
            "order_item_notes": [
                {
                    "title": "string",
                    "body": "string"
                }
            ]
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.duoplane.com/api/orders' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
        }
    ],
    "shipping_address": {
        "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": {
        "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"
    },
    "order_items": [
        {
            "name": "string",
            "quantity": 0,
            "price": 0,
            "retailer_product_id": 0,
            "retailer_sku": "string",
            "internal_id": "string",
            "order_item_notes": [
                {
                    "title": "string",
                    "body": "string"
                }
            ]
        }
    ]
}'

Responses

🟢201Created
application/json
Body

Example
{
    "metadata": {
        "requests_remaining": 0,
        "retry_after_seconds": 0,
        "total_count": 0
    },
    "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-04 03:10:54
Previous
The Order object
Next
Get an order
Built with