Create Incoming Order
Creating an incoming order
Create Incoming order
POST https://api-sandbox.shiplemon.com/v1/incoming-orders/generic
Adds an incoming order in our system
Request Body
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: https://woocommercestore.gr
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": "[email protected]",
"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: https://en.wikipedia.org/wiki/E.164
total*
number
The total amount of the order
currency*
string
Accepts the code of the currency based on the iso 4217
Check more here: https://en.wikipedia.org/wiki/ISO_4217
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": "[email protected]"
}
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: https://en.wikipedia.org/wiki/E.164
id
string
The order id (could be a string or number)
created_at
Date
eg. 2022-02-20T18:14:00.000Z
discount_total
number
The discount amount of the order. Default to 0
Example Request
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
Last updated