Store api - Manage order¶

Swagger: https://sandbox-cn.archiproducts.com/estoreapi/swagger/index.html

Endpoint: Show Orders¶

Method: POST
URL: /estoreapi/api/v1/reseller/orders?culture={culture}&apikey={apikey}

Request¶

Name	Description	Type	Mandatory
`page`	Page number, start by 0	Integer	Y
`pageSize`	Page size (suggest 20)	Integer	Y
`orderKey`	External reference	String	N
`showType`	ResellerOrderShowType	Enum[]	N

ResellerOrderShowType¶

Code	Value
1	PendingPayment
2	DeliveredToHub

Response¶

ResellerOrderListResponse

Name	Description	Type
`orders`	ResellerOrderModel	Object[]
`filter`	ResellerOrderListFilter	Object
`totalCount`	Total item filtered	Integer

ResellerOrderModel¶

Name	Description	Type
`orderCode`	Internal order code	String
`resellerOrderKey`	External order key	String
`orderTotal`	Amount to be paid in EUR	Decimal
`createdDate`	Creation date	DateTime
`paymentStatus`	PaymentStatus	Enum
`lastUpdate`	Last update date	DateTime
`orderStatus`	OrderStatus	Enum

Endpoint: Order Details¶

Method: GET
URL: /estoreapi/api/v1/reseller/order/{orderKey}?culture={culture}&apikey={apikey}

Request¶

The field orderKey is the external reference key.

Response¶

ResellerOrderDetailResponse

Name	Description	Type
`order`	ResellerOrderModel	Object
`items`	ResellerOrderItemModel	Object[]

ResellerOrderItemModel¶

Name	Description	Type
`resellerOrderItemKey`	External order item key	String
`productName`		String
`quantity`		Integer
`price`	Item price in EUR	decimal
`orderStatus`	OrderItemStatus	Integer
`shippingInfo`	ShippingInfo	Object[]
`description`		String
`ean`		String
`articleCode`		String
`expectedDeliveryDate`		Date

Endpoint: Last order updated¶

Method: GET
URL: /estoreapi/api/v1/reseller/lastordersupdate/{lasthours}?culture={culture}&apikey={apikey}

Request¶

Returns the list of the orders updated in the last lasthours

Response¶

Array of ResellerOrderLastUpdateResponse

Name	Description	Type
`orderCode`	Internal order code	String
`resellerOrderKey`	External order key	String
`lastUpdate`	Last update date	Date

Endpoint: Picking unit¶

Method: GET
URL: /estoreapi/api/v1/reseller/pickingunits?culture={culture}&apikey={apikey}

Returns the list of packages ready in the warehouse to be collected with the relative size.
A PickingUnit is a shipping unit, each ShippingUnit is composed of a PickingItem list and a PackingItem list.
The PickingItem list indicates a group of items in an order.
The PackingItem list indicates the composition of the packages.
When a shipment is requested, no more new pickingUnits will be added to the list.
After the pickingUnit list is shipped, the list is emptied.

Response¶

Array of ResellerPickingUnitResponse

Name	Description	Type
`pickingId`	Internal picking id	Integer
`orderCode`	Internal order code	String
`resellerOrderKey`	External order key	String
`pickingItems`	ResellerPickingItemResponse	Object[]
`packingItems`	ResellerPackingItemsResponse	Object[]

ResellerPickingItemResponse¶

Name	Description	Type
`orderItemId`	Internal Order item id	Integer
`resellerOrderItemKey`	External Order item key	String
`quantity`	Quantity of item	Integer

ResellerPackingItemsResponse¶

Name	Description	Type
`refPackage`	Internal reference	Integer
`q`	Quanity of package	Integer
`l`	Length (cm)	Decimal
`d`	Depth (cm)	Decimal
`h`	Height (cm)	Decimal
`w`	Weight (kg)	Decimal
`note`		String

Testing change status¶

More details change status