REST API
Search…
Orders
Create, update and get an order in the Outshifter Platform.

Create an order

The order creation process can be launched through the different payment methods available in the previous section. In case you need to create an order directly to the Outshifter Platform, you can use this endpoint.
post
https://api.outshifter.com/
api/orders
Create order
Endpoint body should mainly include information about:
  • channel
  • final customer
  • purchased products
  • shipping costs
Body example:
1
{
2
channel: 'Partner',
3
channelId: '5',
4
channelOrderName: '#1001',
5
channelCreatedDate: '1994-11-05T13:15:30Z',
6
paymentProcessor: 'Klarna',
7
currency: "NOK",
8
customer: {
9
fullName: 'Jane Doe',
10
11
phone: '+4563727263',
12
shippingContactName: 'Jane Doe',
13
shippingAddress: 'my strret',
14
shippingCity: 'my city',
15
shippingState: 'my state',
16
shippingZip: 'my city',
17
shippingCountry: 'NO',
18
billingName: 'Jane Doe',
19
billingAddress: 'my strret billing',
20
billingZip: 'my zip billing',
21
billingCity: 'my city billing',
22
billingState: 'Oslo',
23
billingCountry: 'NO',
24
},
25
items: [
26
{
27
productId: 25,
28
quantity: 1,
29
priceChannel: 100
30
variantTitle: "M-White"
31
}
32
]
33
shippingItems: [
34
{
35
code: "1214089-FRP",
36
title: "Flat rate price to NO",
37
price: 25
38
}
39
]
40
}
Copied!

Cancel an Order

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

Get orders

This endpoint will retrieve all orders from a seller that have been processed throughout his specific storefront. You will not receive all seller orders but just the ones of that channel.
You will need to provide:
  • the user api key authentification
  • the storefront channel of that partner
get
https://api.outshifter.com/
users/me/orders/:channeld
Get user orders
Filters example:
1
{
2
status: "COMPLETED",
3
dateFrom: "2021-07-01",
4
dateTo: "2021-07-10"
5
}
Copied!