# Order Model

| Name | Data Type | Description |
|  --- | --- | --- |
| `orderId` | number | The system-generated identifier for the order. **Read-Only** field. |
| `orderNumber` | string | A user-defined order number used to identify an order. |
| `orderKey` | string | A user-provided key that should be unique to each order. Can only be initialized during order creation. If the `orderkey` isn't specified during creation, a unique value will be generated and assigned to the order. |
| `orderDate` | string | The date the order was placed. |
| `createDate` | string | The timestamp the order was created in ShipStation's database. **Read-Only** |
| `modifyDate` | string | The timestamp the order was modified in ShipStation. `modifyDate` will equal `createDate` until a modification is made. **Read-Only**. |
| `paymentDate` | string | The date the order was paid for. |
| `shipByDate` | string | The date the order is to be shipped before or on. This field is a suggested value generated by the order source/platform/cart and passed to ShipStation. Not all ShipStation integrations support this field and will show `null` if absent. |
| `orderStatus` | string | The order's status. Possible values: "awaiting_payment", "awaiting_shipment", "shipped", "on_hold", "cancelled" |
| `customerId` | number | Unique identifier for the customer. Generated by ShipStation the first time the customer record is created. **Read-Only** |
| `customerUsername` | string | Identifier for the customer in the originating system. This is typically a username or email address. This value is required to generate a customer profile. |
| `customerEmail` | string | The customer's email address. |
| `billTo` | Object: Array of strings and boolean | [**Address**](/apis/shipstation-v1/docs/models/address) The recipient's billing address. The `residential` boolean specifies whether or not the given address is residential. |
| `shipTo` | Object: Array of strings and boolean | [**Address**](/apis/shipstation-v1/docs/models/address) The recipient's shipping address. The `residential` boolean specifies whether or not the given address is residential. |
| `items` | Object: Array of strings and boolean | [**OrderItem**](/apis/shipstation-v1/docs/models/order-item) Array of purchased items. |
| `orderTotal` | number | The order total. **NOTE**: This is a **Read-Only** field. |
| `amountPaid` | number | The total amount paid for the Order. |
| `taxAmount` | number | The total tax amount for the Order. |
| `shippingAmount` | number | Shipping amount paid by the customer, if any. |
| `customerNotes` | string | Notes left by the customer when placing the order. |
| `internalNotes` | string | Private notes that are only visible to the seller. |
| `gift` | boolean | Specifies whether or not this order is a gift. |
| `giftMessage` | string | Gift message left by the customer when placing the order. |
| `paymentMethod` | string | Method of payment used by the customer. |
| `requestedShippingService` | string | Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart. If the value is "null" then the marketplace or cart does not support this field in ShipStation. |
| `carrierCode` | string | The code for the carrier that is to be used (or was used) when this order is shipped (was shipped). |
| `serviceCode` | string | The code for the shipping service that is to be used (or was used) when this order is shipped (was shipped). |
| `packageCode` | string | The code for the package type that is to be used (or was used) when this order is shipped (was shipped). |
| `confirmation` | string | The type of delivery confirmation that is to be used (or was used) when this order is shipped (was shipped). |
| `shipDate` | string | The date the order was shipped. |
| `holdUntilDate` | string | If placed on hold, this date is the expiration date for this order's hold status. The order is moved back to `awaiting_shipment` status on this date. |
| `weight` | Object: numbers and strings | [**Weight**](/apis/shipstation-v1/docs/models/weight) of the order. |
| `dimensions` | Object: numbers and strings | [**Dimensions**](/apis/shipstation-v1/docs/models/dimensions) of the order. |
| `insuranceOptions` | Object: numbers, strings, and boolean | The shipping insurance information associated with this order. Learn more about [**InsuranceOptions**](/apis/shipstation-v1/docs/models/insurance-options) |
| `internationalOptions` | Object: strings, and an Array of customs items | Customs information that can be used to generate customs documents for international orders. Learn more about [**InternationalOptions**](/apis/shipstation-v1/docs/models/international-options) |
| `advancedOptions` | Object: numbers, strings, and boolean | Various [**AdvancedOptions**](/apis/shipstation-v1/docs/models/advanced-options) may be available depending on the shipping carrier that is used to ship the order. |
| `tagIds` | Array of numbers or Null | The numbers in the array are the `tagIds`. (number[] / null) Each `tagId` identifies a tag that has been associated with this order. See also [**Add Tag to Order**](/apis/shipstation-v1/openapi/orders/add_tag_to_order), [**List Orders by Tag**](/apis/shipstation-v1/openapi/orders/list_orders_by_tag), [**Remove Tag from Order**](/apis/shipstation-v1/openapi/orders/remove_tag_from_order), [**Product Tag**](/apis/shipstation-v1/docs/models/product-tag), and [**List Products**](/apis/shipstation-v1/openapi/products/list_products). |
| `userId` | string | User assigned to Order/Shipment in the GUID. **Read-Only**. |
| `externallyFulfilled` | boolean | States whether or not the order is currently marked as being externally fulfilled by the marketplace. A common example is when an Amazon order is marked an Amazon Fulfilled Network (AFN). If the order is an AFN then this element will be *true*. **Read-Only**. |
| `externallyFulfilledBy` | string | If `externallFulfilled` is *true*, then this string will return how the order is being fulfilled by the marketplace. **Read-Only**. |