Create an order

POST https://:account.api-us1.com/api/3/ecomOrders

JSON

{
  "ecomOrder": {
    "externalid": "3246315233",
    "source": "1",
    "email": "alice@example.com",
    "orderNumber": "1057",
    "orderProducts": [
      {
        "externalid": "PROD12345",
        "name": "Pogo Stick",
        "price": "4900",
        "quantity": "1",
        "category": "Toys"
      },
      {
        "externalid": "PROD23456",
        "name": "Skateboard",
        "price": "3000",
        "quantity": "1",
        "category": "Toys"
      }
    ],
    "orderUrl": "https://example.com/orders/3246315233",
    "orderDate": "2016-09-13T17:41:39-04:00",
    "shippingMethod": "UPS Ground",
    "totalPrice": "9111",
    "currency": "USD",
    "connectionid": "1",
    "customerid": "1"
  }
}

201 Created

{
  "ecomOrder": {
    "externalid": "3246315233",
    "source": "1",
    "email": "alice@example.com",
    "currency": "USD",
    "connectionid": "1",
    "customerid": "1",
    "orderNumber": "1057",
    "orderUrl": "https://example.com/orders/3246315233",
    "orderDate": "2016-09-13T17:41:39-04:00",
    "shippingMethod": "UPS Ground",
    "totalPrice": "9111",
    "totalProducts": 2,
    "customer": "1",
    "orderProducts": [
      "2",
      "3"
    ],
    "links": {
      "customer": "/api/3/ecomOrders/2/customer",
      "orderProducts": "/api/3/ecomOrders/2/orderProducts"
    },
    "id": "2"
  },
  "ecomOrderProducts": [
    {
      "orderid": "2",
      "connectionid": "1",
      "externalid": "PROD12345",
      "name": "Pogo Stick",
      "price": "4900",
      "quantity": "1",
      "category": "Toys",
      "tstamp": "2017-02-07T10:25:12-06:00",
      "links": {
        "ecomOrder": "/api/3/ecomOrderProducts/2/ecomOrder"
      },
      "id": "2",
      "ecomOrder": "2"
    },
    {
      "orderid": "2",
      "connectionid": "1",
      "externalid": "PROD23456",
      "name": "Skateboard",
      "price": "3000",
      "quantity": "1",
      "category": "Toys",
      "tstamp": "2017-02-07T10:25:12-06:00",
      "links": {
        "ecomOrder": "/api/3/ecomOrderProducts/3/ecomOrder"
      },
      "id": "3",
      "ecomOrder": "2"
    }
  ]
}

BODY PARAMS

ecomOrder

object

ecomOrder.externalid REQUIRED

string The id of the order in the external service.

ecomOrder.source

int32 The order source code (0 - sync, 1 - realtime webhook).

ecomOrder.email REQUIRED

string The email address of the customer who placed the order.

ecomOrder.orderProducts

object

ecomOrder.orderProducts.name REQUIRED

string The name of the product

ecomOrder.orderProducts.price REQUIRED

int32 The price of the product, in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.

ecomOrder.orderProducts.quantity REQUIRED

int32 The quantity ordered.

ecomOrder.orderProducts.externalid

string The id of the product in the external service.

ecomOrder.orderProducts.category

string The category of the product.

ecomOrder.totalPrice REQUIRED

int32 The total price of the order in cents, including tax and shipping charges. (i.e. $456.78 => 45678). Must be greater than or equal to zero.

ecomOrder.currency REQUIRED

string The currency of the order (3-digit ISO code, e.g., 'USD').

ecomOrder.connectionid REQUIRED

int32 The id of the connection from which this order originated.

ecomOrder.customerid REQUIRED

int32 The id of the customer associated with this order.

ecomOrder.orderNumber

string The order number in the external system (this may differ from the externalid).

ecomOrder.orderUrl

string The URL for the order in the external service.

ecomOrder.orderDate REQUIRED

date The date the order was placed.

ecomOrder.shippingMethod

string The shipping method of the order.

Artikelen in deze sectie

POST https://:account.api-us1.com/api/3/ecomOrders

BODY PARAMS

Opmerkingen