`order` object¶

An order object contains the properties that define a sales order in DropStream.

Order objects are listed by the /orders endpoint.

`order` schema¶

{
  "order": {
    "id": integer,
    "store_id": integer,
    "external_id": "string",
    "external_billing_customer_id": "string",
    "customer_email": "string",
    "external_shipping_customer_id": "string",
    "ordered_at": "dateString",
    "invoice_number": "string",
    "payment_type": "string",
    "external_warehouse_order_id": "string",
    "shipping_carrier_name": "string",
    "shipping_carrier_service_level": "string",
    "shipping_warehouse_code": "string",
    "signature_required": boolean,
    "shipping_insurance": boolean,
    "external_shipping_description": "string",
    "external_display_id": "string",
    "external_source_display_id": "string",
    "purchase_order_id": "string",
    "notes": "string",
    "shipping_notes": "string",
    "gift_message": "string",
    "batch_id": "string",
    "shipping_amount": "decimal(8,2)",
    "discount_amount": "decimal(8,2)",
    "tax_amount": "decimal(8,2)",
    "shipping_tax_amount": "decimal(8,2)",
    "third_party_account_number": "string",
    "third_party_billing_code": "string",
    "discount_codes": "string",
    "external_source_id": "string",
    "lead_source": "string",
    "packing_slip_id": "striing",
    "requested_ship_date": "dateString",
    "requested_cancel_date": "dateString",
    "payment_date": "dateString",
    "external_tags": "string (comma-delimited values)",
    "retailer_id": "string",
    "supplier_id": "string",
    "insured_amount": "decimal(8,2)",
    "terms": "string",
    "sales_rep_last_name": "string",
    "sales_rep_first_name": "string",
    "sales_rep_email": "string",
    "fulfillment_state": "string",
    "fulfillment_transitioned_at": "dateString",
    "external_type": "string",
    "fulfillment_warehouse_id": integer,
    "country_of_origin": "string (2-char code)",
    "shipment_contents": "string (16777215)",
    "declared_value": "decimal(8,2)",
    "currency_code": "USD",
    "customer_service_url": "string",
    "customer_service_email": "string",
    "customer_service_telephone": "string",
    "created_at": "dateString",
    "custom": {
      "key1": "string",
      "key2": "string"
      },
    }
    "shipping_address": {
      "first_name": "string",
      "last_name": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "region": "string",
      "postal_code": "string",
      "country": "string (2-char code)",
      "telephone": "string"
    },
    "billing_address": {
      "first_name": "string",
      "last_name": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "region": "string",
      "postal_code": "string",
      "country": "string (2-char code)",
      "telephone": "string"
    },
    "order_items": [
      {
        "name": "string",
        "sku": "string",
        "upc": "string",
        "unit_price": "decimal(8,2)",
        "unit_cost": "decimal(8,2)",
        "weight": "decimal(10,2)",
        "external_order_item_id": "string",
        "discount_amount": "decimal(8,2)",
        "tax_amount": "decimal(8,2)",
        "gift_wrap": boolean,
        "external_product_id": "string",
        "customer_notes": "string",
        "vendor_id": "string",
        "vendor_part_number": "string",
        "buyer_part_number": "string",
        "color_description": "string",
        "size_description": "string",
        "drop_ship": "string",
        "product_type": "string",
        "created_at": "dateString"
        "options": [
          {
            "gift_message": "string"
          }
        ],
        "custom": {
          "gift_message": "string"
        }
      }
(other order_items if any...)
    ]
  }
}

`order` properties¶

`batch_id`¶

Property	`batch_id`
Data type	string
Description	External platform's batch ID for the order
Example	`"TRAN3734"`

`country_of_origin`¶

Property	`country_of_origin`
Data type	string (2-char code)
Description	Two-character code of the country where the order originated
Example	`"US"`

`created_at`¶

Property	`created_at`
Data type	dateString
Description	DateTime when the order was imported to DropStream
Example	`2022-10-03T04:28:20Z`

`currency_code`¶

Property	`currency_code`
Data type	string
Description	Currency code applied to monetary amounts for the order
Example	`"USD"`

`customer_email`¶

Property	`customer_email`
Data type	string
Description	The customer's email address

`customer_service_email`¶

Property	`customer_service_email`
Data type	string
Description	Email address for customer service associated with the order
Example	`"customer.service@website.com"`

`customer_service_telephone`¶

Property	`customer_service_telephone`
Data type	string
Description	Telephone number for customer service associated with the order
Example	`"(123) 456-7890"`

`customer_service_url`¶

Property	`customer_service_url`
Data type	string
Description	Website URL for customer service associated with the order
Example	`"https://website.com/customer-service/"`

`declared_value`¶

Property	`declared_value`
Data type	decimal (8.2)
Description	Declared monetary amount of order contents value
Note	E.g. for customs purposes

`discount_amount`¶

Property	`discount_amount`
Data type	decimal (8.2)
Description	Monetary amount deducted from total order price
Example	`1.23`

`discount_codes`¶

Property	`discount_codes`
Data type	string
Description	Discount code(s) applied to the order, if applicable
Example	`"ABC1, ABC2"`

`external_billing_customer_id`¶

Property	`external_billing_customer_id`
Data type	string
Description	The external platform's billing customer ID

`external_display_id`¶

Property	`external_display_id`
Data type	string
Description	The order ID displayed to the customer in the sales platform
Example	`"SO12345"`

`external_id`¶

Property	`external_id`
Data type	string
Description	The external platform's order ID

`external_shipping_customer_id`¶

Property	`external_shipping_customer_id`
Data type	string
Description	The external platform's shipping customer ID

`external_shipping_description`¶

Property	`external_shipping_description`
Data type	string
Description	The shipping method description, as defined in the sales channel
Note	In DropStream, this string is mapped to a `shipping_carrier_name`, `shipping_carrier_service_level`, and `shipping_warehouse_code` by a Shipping Transformer rule
Example	`"Free Shipping"`

`external_source_display_id`¶

Property	`external_source_display_id`
Data type	string
Description	The external platform's displayed order source ID
Example	`"AMZN510"`

`external_source_id`¶

Property	`external_source_id`
Data type	string
Description	External platform's order source ID
Example	`"ABC123"`

`external_tags`¶

Property	`external_tags`
Data type	string (comma-delimited values)
Description	Comma-delimited list of order tags
Example	`"ABC1,ABCDEF-2,ABC3"`

`external_type`¶

Property	`external_type`
Data type	string
Description	External platform order type
Example	`"ABC123"`

`external_warehouse_order_id`¶

Property	`external_warehouse_order_id`
Data type	string
Description	The ID assigned to the order by the WMS after it was sent to the warehouse

`fulfillment_state`¶

Property	`fulfillment_state`
Data type	string
Description	DropStream internal fulfillment state for the order
Note	One of: `archived` `bundled` `canceled` `delayed_processing` `delayed_sending_completion_acknowledgement` `delayed_sending_receipt_acknowledgement` `delayed_sending_to_warehouse` `error` `error_processing` `error_sending_completion_acknowledgement` `error_sending_receipt_acknowledgement` `error_sending_to_warehouse` `new` `new_manual` `partially_shipped` `pending_shipment` `processing` `queued` `ready_for_warehouse` `scheduled_completion_acknowledgement` `scheduled_processing_order` `scheduled_receipt_acknowledgement` `scheduled_request` `sending_completion_acknowledgement` `sending_receipt_acknowledgement` `sending_to_warehouse` `sent_completion_acknowledgement` `sent_to_warehouse` `shipped` `skipped` `split` `waiting`
Example	`"pending_shipment"`

`fulfillment_transitioned_at`¶

Property	`fulfillment_transitioned_at`
Data type	dateString
Description	DateTime when current `fulfillment_state` was set
Example	`2021-10-15T03:25:01Z`

`fulfillment_warehouse_id`¶

Property	`fulfillment_warehouse_id`
Data type	integer
Description	DropStream warehouse ID this order is assigned to be fulfilled by
Example	`1234`

`gift_message`¶

Property	`gift_message`
Data type	string
Description	Gift message
Example	`"Happy Birthday, Love Mom"`

`id`¶

Property	`id`
Data type	integer
Description	Unique ID of this order, assigned upon creation
Note	In other contexts, `"order_id"` refers to this property
Example	`123456789`

`insured_amount`¶

Property	`insured_amount`
Data type	decimal (8.2)
Description	Monetary amount the order is insured for for
Example	`123.45`

`invoice_number`¶

Property	`invoice_number`
Data type	string
Description	The invoice number, if applicable

`lead_source`¶

Property	`lead_source`
Data type	string
Description	Lead source for the sale, if applicable

`notes`¶

Property	`notes`
Data type	string
Description	Order notes

`order_items`¶

Property	`order_items`
Data type	Array of order_item objects
Description	Items on this order
Example	`[ { "name": "Red Shirt", "sku": "RDSHRT-123", "unit_price": "1.0", "external_order_item_id": "4403098091556", "discount_amount": "0.0", "external_product_id": "4508015558692", "vendor_id": "Jane's Apparel", "created_at": "2022-02-23T16:52:18Z" } ]`

`ordered_at`¶

Property	`ordered_at`
Data type	dateString
Description	DateTime when the order was placed
Example	`2022-11-29T03:20:18Z`

`packing_slip_id`¶

Property	`packing_slip_id`
Data type	string
Description	Packing slip ID

`payment_date`¶

Property	`payment_date`
Data type	dateString
Description	Date when the customer paid for the order
Example	`2022-10-03T12:25:07Z`

`payment_type`¶

Property	`payment_type`
Data type	string
Description	The platform-defined payment type of the order
Example	`"paypal"`

`purchase_order_id`¶

Property	`purchase_order_id`
Data type	string
Description	The purchase order ID, if applicable
Example	`"PO15604"`

`requested_cancel_date`¶

Property	`requested_cancel_date`
Data type	dateString
Description	Date when the order was requested to be canceled
Example	`2022-10-08T21:48:57Z`

`requested_ship_date`¶

Property	`requested_ship_date`
Data type	dateString
Description	Requested ship date
Example	`2022-10-05T01:43:07Z`

`retailer_id`¶

Property	`retailer_id`
Data type	string
Description	Retailer ID
Example	`"Target"`

`sales_rep_email`¶

Property	`sales_rep_email`
Data type	string
Description	Sales rep email address
Example	`"jane.smith@email.com"`

`sales_rep_first_name`¶

Property	`sales_rep_first_name`
Data type	string
Description	Sales rep first name
Example	`"Jane"`

`sales_rep_last_name`¶

Property	`sales_rep_last_name`
Data type	string
Description	Sales rep last name
Example	`"Smith"`

`shipment_contents`¶

Property	`shipment_contents`
Data type	string (16777215)
Description	Verbose description of shipment contents
Note	E.g. for customs purposes

`shipping_amount`¶

Property	`shipping_amount`
Data type	decimal (8.2)
Description	Monetary amount of shipping price
Example	`1.23`

`shipping_carrier_name`¶

Property	`shipping_carrier_name`
Data type	string
Description	Name of the shipping carrier, as set by the store's Shipping Transformer rule
Example	`"UPS"`

`shipping_carrier_service_level`¶

Property	`shipping_carrier_service_level`
Data type	string
Description	Carrier service level, as set by the store's Shipping Transformer rule
Example	`"Ground"`

`shipping_insurance`¶

Property	`shipping_insurance`
Data type	boolean
Description	True if the shipment is insured
Example	`true`

`shipping_notes`¶

Property	`shipping_notes`
Data type	string
Description	Shipping notes

`shipping_tax_amount`¶

Property	`shipping_tax_amount`
Data type	decimal (8.2)
Description	Monetary amount of tax added to shipping price
Example	`1.23`

`shipping_warehouse_code`¶

Property	`shipping_warehouse_code`
Data type	string
Description	The warehouse shipping code for the carrier and service level, as set by the store's Shipping Transformer rule
Example	`"UPSG"`

`signature_required`¶

Property	`signature_required`
Data type	boolean
Description	True if recipient signature is required for delivery
Example	`false`

`store_id`¶

Property	`store_id`
Data type	integer
Description	Unique ID of the store associated with this order
Example	`1234`

`supplier_id`¶

Property	`supplier_id`
Data type	string
Description	Supplier ID
Example	`"Williams Sonoma Inc"`

`tax_amount`¶

Property	`tax_amount`
Data type	decimal (8.2)
Description	Monetary amount of tax added to total order price
Example	`1.23`

`terms`¶

Property	`terms`
Data type	string
Description	Order terms
Example	`"COD"`

`third_party_account_number`¶

Property	`third_party_account_number`
Data type	string
Description	Third-party account number for the order
Example	`"ABC123"`

`third_party_billing_code`¶

Property	`third_party_billing_code`
Data type	string
Description	Third-party billing code for the order
Example	`"ABC123"`

order object¶

order schema¶

order properties¶

batch_id¶

country_of_origin¶

created_at¶

currency_code¶

customer_email¶

customer_service_email¶

customer_service_telephone¶

customer_service_url¶

declared_value¶

discount_amount¶

discount_codes¶

external_billing_customer_id¶

external_display_id¶

external_id¶

external_shipping_customer_id¶

external_shipping_description¶

external_source_display_id¶

external_source_id¶

external_tags¶

external_type¶

external_warehouse_order_id¶

fulfillment_state¶

fulfillment_transitioned_at¶

fulfillment_warehouse_id¶

gift_message¶

id¶

insured_amount¶

invoice_number¶

lead_source¶

notes¶

order_items¶

ordered_at¶

packing_slip_id¶

payment_date¶

payment_type¶

purchase_order_id¶

requested_cancel_date¶

requested_ship_date¶

retailer_id¶

sales_rep_email¶

sales_rep_first_name¶

sales_rep_last_name¶

shipment_contents¶

shipping_amount¶

shipping_carrier_name¶

shipping_carrier_service_level¶

shipping_insurance¶

shipping_notes¶

shipping_tax_amount¶

shipping_warehouse_code¶

signature_required¶

store_id¶

supplier_id¶

tax_amount¶

terms¶

third_party_account_number¶

third_party_billing_code¶

`order` object¶

`order` schema¶

`order` properties¶

`batch_id`¶

`country_of_origin`¶

`created_at`¶

`currency_code`¶

`customer_email`¶

`customer_service_email`¶

`customer_service_telephone`¶

`customer_service_url`¶

`declared_value`¶

`discount_amount`¶

`discount_codes`¶

`external_billing_customer_id`¶

`external_display_id`¶

`external_id`¶

`external_shipping_customer_id`¶

`external_shipping_description`¶

`external_source_display_id`¶

`external_source_id`¶

`external_tags`¶

`external_type`¶

`external_warehouse_order_id`¶

`fulfillment_state`¶

`fulfillment_transitioned_at`¶

`fulfillment_warehouse_id`¶

`gift_message`¶

`id`¶

`insured_amount`¶

`invoice_number`¶

`lead_source`¶

`notes`¶

`order_items`¶

`ordered_at`¶

`packing_slip_id`¶

`payment_date`¶

`payment_type`¶

`purchase_order_id`¶

`requested_cancel_date`¶

`requested_ship_date`¶

`retailer_id`¶

`sales_rep_email`¶

`sales_rep_first_name`¶

`sales_rep_last_name`¶

`shipment_contents`¶

`shipping_amount`¶

`shipping_carrier_name`¶

`shipping_carrier_service_level`¶

`shipping_insurance`¶

`shipping_notes`¶

`shipping_tax_amount`¶

`shipping_warehouse_code`¶

`signature_required`¶

`store_id`¶

`supplier_id`¶

`tax_amount`¶

`terms`¶

`third_party_account_number`¶

`third_party_billing_code`¶