mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-08 04:21:27 +00:00
23 lines
16 KiB
Markdown
23 lines
16 KiB
Markdown
# OrderCreateRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `placed_at` | *str* | :heavy_check_mark: | Date and time when the order was placed. This datetime can be different from the datetime of the order object creation on Shippo. | 2016-09-23T01:28:12Z |
|
|
| `to_address` | [components.AddressCreateRequest](../../models/components/addresscreaterequest.md) | :heavy_check_mark: | <a href="#tag/Addresses">Address</a> object of the recipient / buyer. Will be returned expanded by default. | |
|
|
| `currency` | *Optional[str]* | :heavy_minus_sign: | **Required if total_price is provided**<br><br/>Currency of the <code>total_price</code> and <code>total_tax</code> amounts. | USD |
|
|
| `notes` | *Optional[str]* | :heavy_minus_sign: | Custom buyer- or seller-provided notes about the order. | This customer is a VIP |
|
|
| `order_number` | *Optional[str]* | :heavy_minus_sign: | An alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique. | #1068 |
|
|
| `order_status` | [Optional[components.OrderCreateRequestOrderStatus]](../../models/components/ordercreaterequestorderstatus.md) | :heavy_minus_sign: | Current state of the order. See the <a href="https://docs.goshippo.com/docs/orders/orders/">orders tutorial</a> <br/>for the logic of how the status is handled. | PAID |
|
|
| `shipping_cost` | *Optional[str]* | :heavy_minus_sign: | Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping. | 12.83 |
|
|
| `shipping_cost_currency` | *Optional[str]* | :heavy_minus_sign: | **Required if shipping_cost is provided**<br><br/>Currency of the <code>shipping_cost</code> amount. | USD |
|
|
| `shipping_method` | *Optional[str]* | :heavy_minus_sign: | Shipping method (carrier + service or other free text description) chosen by the buyer. <br/>This value can be different from the shipping method the seller will actually choose. | USPS First Class Package |
|
|
| `subtotal_price` | *Optional[str]* | :heavy_minus_sign: | N/A | 12.1 |
|
|
| `total_price` | *Optional[str]* | :heavy_minus_sign: | Total amount paid by the buyer for this order. | 24.93 |
|
|
| `total_tax` | *Optional[str]* | :heavy_minus_sign: | Total tax amount paid by the buyer for this order. | 0.0 |
|
|
| `weight` | *Optional[str]* | :heavy_minus_sign: | Total weight of the order. | 0.4 |
|
|
| `weight_unit` | [Optional[components.WeightUnit]](../../models/components/weightunit.md) | :heavy_minus_sign: | The unit used for weight. | lb |
|
|
| `from_address` | [Optional[components.AddressCreateRequest]](../../models/components/addresscreaterequest.md) | :heavy_minus_sign: | <a href="#tag/Addresses">Address</a> object of the sender / seller. Will be returned expanded by default.. | |
|
|
| `line_items` | List[[components.LineItemBase](../../models/components/lineitembase.md)] | :heavy_minus_sign: | Array of <a href="#section/Line-Item">line item</a> objects representing the items in this order. <br/>All objects will be returned expanded by default. | | |