> For the complete documentation index, see [llms.txt](https://docs.shiplemon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiplemon.com/endpoints/incoming-orders/create-incoming-order.md).
# Create Incoming Order
## Create Incoming order
`POST` `https://api-sandbox.shiplemon.com/v1/incoming-orders/generic`
Adds an incoming order in our system
#### Request Body
| Name | Type | Description |
| ------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| store\_id | string | The unique store url to avoid overwrites when orders from multiple stores have the same id. For link compatibility, also add the url protocol.
Eg. value:
|
| shipment\_id | string | The id of the related shipment from [Create Shipment](/endpoints/shipments/create-shipment.md#create-shipment) |
| status | string | The status of the order:
One of: processing, completed
|
| items\* | array | {
id: number;
name: string;
quantity: string;
price: number;
sku?: string;
width: string;
length: string;
height: string;
weight: string;
image\_url: string;
}
|
| shipping\* | object | {
"first\_name": "First Name",
"last\_name": "Last Name",
"company": "Company",
"address\_1": "Address 1",
"address\_2": "2nd floor",
"city": "city",
"state": "state",
"postcode": "postcode",
"country": "GR",
"phone": "phone",
"email": "",
"notes: "Beware of the dog"
}
company, address\_2, and state are optional and can accept null
Country is a 2 letter ISO code
Phone is either local phone or for non GR destination prefix with country code:
|
| total\* | number | The total amount of the order |
| currency\* | string | Accepts the code of the currency based on the iso 4217
Check more here:
|
| shipping\_total | number | The shipping amount of the order
Default to 0
|
| billing\* | object | {
"first\_name": "First Name",
"last\_name": "Last Name",
"company": "Company",
"address\_1": "Address 1",
"address\_2": "2nd floor",
"city": "city",
"state": "state",
"postcode": "postcode",
"country": "GR",
"phone": "phone",
"email": ""
}
company, address\_2, and state are optional and can accept null
Country is a 2 letter ISO code
Phone is either local phone or for non GR destination prefix with country code:
|
| id | string | The order id (could be a string or number) |
| payment\_method | string | [#payment-methods](#payment-methods "mention") |
| payment\_status | string | [#payment-statuses](#payment-statuses "mention") |
| created\_at | Date | eg. 2022-02-20T18:14:00.000Z |
| discount\_total | number | The discount amount of the order.
Default to 0
|
{% tabs %}
{% tab title="200 " %}
```
```
{% endtab %}
{% endtabs %}
## Example Request
{% tabs %}
{% tab title="cURL" %}
```erlang
curl --location --request POST 'http://api-sandbox.shiplemon.com/v1/incoming-orders/generic' \
--header 'x-api-key: {{API_KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 1,
"store_id": "https://test-store.gr",
"shipment_id": null,
"currency": "eur",
"shipping_total": 3,
"total": 22,
"billing": {
"first_name": "first_name",
"last_name": "last_name",
"company": "company",
"address_1": "address_1",
"address_2": "address_2",
"city": "city",
"state": null,
"postcode": "12345",
"country": "GR",
"phone": "+306900000000",
"email": "email@domain.com"
},
"shipping": {
"first_name": "first_name",
"last_name": "last_name",
"company": "company",
"address_1": "address_1",
"address_2": "address_2",
"city": "Athens",
"state": "Attica",
"postcode": "12345",
"country": "GR",
"phone": "+306900000000",
"email": "email@domain.com"
},
"payment_method": "cash_on_delivery",
"payment_status": "pending",
"created_at": "2022-02-20T18:14:00.000Z",
"items": [
{
"id": "product_id",
"name": "name",
"quantity": 2,
"price": 11,
"width": 0,
"length": 0,
"height": 0,
"weight": 0,
"image_url": null
}
]
}'
```
{% endtab %}
{% endtabs %}
### Payment methods
Inside an order `payment_method` listed above should be one of the following fields:
* cash\_on\_delivery
* bank\_transfer
* paypal
* card
* free
* unknown
### Payment Statuses
Inside an order `payment_status` listed above should be one of the following fields:
* pending
* paid
## Example response
```
{
"status": "ok",
"data": {
"id": "820b648b-2d06-4786-8b13-73a6dc8b4aec",
"state": "new",
"store_id": "https://test-store.gr",
"source_id": "1",
"shipment_id": null,
"total": 22,
"currency": "eur",
"payment_method": "cash_on_delivery",
"payment_status": "pending",
"billing_address": {
"company": "string",
"first_name": "string",
"last_name": "string",
"address_1": "string",
"address_2": "string",
"country": "string",
"state": "string",
"postcode": "string",
"city": "string",
"phone": "string",
"email": "string"
},
"shipping_address": {
"company": "string",
"first_name": "string",
"last_name": "string",
"address_1": "string",
"address_2": "string",
"country": "string",
"state": "string",
"postcode": "string",
"city": "string",
"phone": "string",
"email": "string",
"notes": null
},
"shipping_option": {
"driver": null,
"service": null
},
"ecommerce_token": null,
"ecommerce_id": "1",
"ecartapi_id": null,
"has_shipment_draft": false,
"items": [
{
"id": "product_id",
"name": "name",
"quantity": 2,
"price": 11,
"width": 0,
"height": 0,
"length": 0,
"weight": 0,
"image_url": null
}
],
"completed": false,
"deleted_at": null,
"created_at": "2022-02-20T18:14:00.000Z",
"updated_at": "2022-10-10T16:02:43.825Z"
}
}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.shiplemon.com/endpoints/incoming-orders/create-incoming-order.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.