Order mandatory sections
Header
Order basic information
Yes
Items
Collection of items in the order
Yes Maximum 50 items.
§ Product
The product referred on each item
Yes
Buyer
Buyer basic information
Yes
§ Address
Buyer address
Yes
§ Billing information
Buyer billing information data.
No
§ Billing address
Buyer billing information address
No
Payments
Collection of payments in the order
Yes Maximum 10 items.
§ Discounts
Collection of discounts applied to the payment
No Maximum 10 items.
§ Taxes
The amount of taxes involved
No
Shipping
Shipping information
Yes
§ CourierInfo
The courier that collects and delivers
the order.
No, except if the shipment is configured to the "Courier" logistics type option.
§ Cost
Monetary costs involved in the shipping
Yes
§ Receiver
Basic receiver data
Yes
§ Receiver address
Physical address and location of the package delivery
Yes, except if the shipment is configured to the "Pick up" option.
§ Pickup
Pickup data where the customer gets the package.
(If the shipment is configured to the "Pick up" option)
No, except if the shipment is configured to the "Pick up" option.
About the Alephee given account… • The account ID used for creating a new order must have the "Work with orders” privilege activated. Also, may be necessary the "Work with product stock” privilege activated. • Bear in mind the type and profile of the given account: Brand, Distributor, Seller, Official Store, Pickup in Store. Select the correct one matching your current Alephee configuration.
About order status… • The status of a whole order results from the status of all the items in that order. You must set the status of each of the items in the order individually. • Alephee will manage each item status one by one. • Double check the value of “Integrated” flag. This will affect following calls to the GET order endpoint.
About inventory and products stock.... • On the same order, you cannot repeat more than one time the same product with the same quantity and the same unit price. • When a new order is created, for each one of the items, it is possible to define whether the current inventory/stock in Alephee for that product will be updated. The “StockMovement” attribute in the items section us used for this. • If “StockMovement” attribute is “True” Alephee will update the product’s inventory current value. If the attribute contains value of “False” no product inventory will be updated. • Future cancellations or deletions of the created order would revert the stock movement if the order originally updated the product inventory/stock.
About an item with an existent product in catalog… When sending an order item with a product that already exists in the Alephee catalog, the brand / SKU code of the product must be informed. • The 'Brand' parameter won’t be mandatory, if the (SKU) codes in the product catalog are unique. If there are two (SKU) codes with different brands, the change will be reported as invalid. • The 'Brand' parameter can be set by ID or Name. • The 'SKU' parameter is mandatory and must match with the product SKU code in the catalog. • The 'SKU' parameter works also for looking the product 'Owncode' code in the catalog. • The given price has priority over the price of the product in the catalog. The price reported in the JSON is always taken, regardless of the price of the product in the catalog.
About an item with a nonexistent product in catalog… When sending an order item with a product that does NOT exist in Alephee 's catalog, a "disconnected product" will be generated. • The “Title” attribute will be mandatory.
About prices attributes... • All informed price fields values must NOT be empty nor 0 (zero). All values should be of as higher value than 0 (zero). • All of the price attributes formats must be a decimal number with a period (.) as a decimal notation, no notation is needed for thousands or millions. The maximum number of decimal digits is 4. For example, 1288.44, 7430 or 7430.00. • No single one attribute “with discounts” can result in a higher value than the same attribute "without discount”. For example, “Amount” (which includes discounts) cannot result in a higher value than “AmountNoDiscount” (without discounts).
About quantities attributes... • All informed stock fields values must NOT be empty. All values should be of as equal or higher value than 0 (zero). Do NOT use a negative stock value. • All of the stock attributes formats must be an integer number with no decimal notation and no notation is needed for thousands or millions.
About date and time attributes... • All of the date and time attributes formats must be a string with UTC and ISO timezone format. e.g.: "yyyy-mm-ddThh:mm:ssZ". Please note the "T" and "Z" literals. Example: If your local time zone is UTC-4 then you need to ADD 4 hours to the DateTimes attributes before sending the values in the JSON package. Example: If your local time zone is UTC+2 then you need to SUBSTRACT 2 hours to the DateTimes attributes before sending the values in the JSON package.
About shipping objects and attributes... • Do not send the “Pickup” object when the order is not set to pick up withdrawal. Always send this object when the order is set to that shipping method. • Always provide the shipping costs, the total, the buyer and the seller’s shipping costs.
Last updated
Was this helpful?