REST API
Search…
⌃K

Orders

Create, receive and update orders.

Create an Order

The order creation process can be launched through the payment method, as explained in the previous section. If you need to create an order directly to Outshifter, you can use the orders endpoint.
post
https://api.outshifter.com/
api/orders
Create order
Endpoint body should primarily include information about:
  • Channel
  • Final Customer
  • Purchased Products
  • Shipping Costs
Body example:
{
"channel": "Partner",
"channelId": "5",
"channelOrderName": "#1001",
"channelCreatedDate": "1994-11-05T13:15:30Z",
"paymentProcessor": "Klarna",
"currency": "NOK",
"customer": {
"fullName": "Jane Doe",
"email": "[email protected]",
"phone": "+4563727263",
"shippingContactName":"Jane Doe",
"shippingAddress": "my strret",
"shippingCity":"my city",
"shippingState":"my state",
"shippingZip":"my city",
"shippingCountry":"NO",
"billingName":"Jane Doe",
"billingAddress": "my strret billing",
"billingZip": "my zip billing",
"billingCity": "my city billing",
"billingState": "Oslo",
"billingCountry": "NO"
},
"items": [
{
"productId": 25,
"quantity": 1,
"priceChannel": 100,
"variantTitle": "M-White"
}
],
"shippingItems": [
{
"code": "1214089-FRP",
"title": "Flat rate price to NO",
"price": 25
}
]
}

Cancel an Order

This endpoint allows you to update the order item status to “CANCELED”, for instance if a customer cancels their order.
If the order only has one product, the whole order will be canceled. However, if the order has several products, you will need to cancel each item individually.
Order cancellation is available only before shipping has taken place. If the customer has already received the item(s) or they have been shipped a return must be initiated in the Outshifter return solution.
put
https://api.outshifter.com/
orders/:id/items/:itemId
Cancel an order

Get orders

This endpoint will retrieve all orders from a Channel that have been processed in a specific storefront. In order to fetch the order information you will need to provide:
  • The user API key authentification
  • The channel storefront
get
https://api.outshifter.com/
users/me/orders/:channeld
Get user orders
Filters example:
{
"status": "COMPLETED",
"dateFrom": "2021-07-01",
"dateTo": "2021-07-10"
}