0% found this document useful (0 votes)
53 views5 pages

Documentatie API Emag Marketplace

The document outlines the process for proposing offers in campaigns and processing orders, detailing the required fields and constraints for each. It specifies the order statuses, properties, and various customer and product details necessary for order management. Additionally, it includes information on voucher discounts and cancellation reasons, providing a comprehensive guide for handling campaign offers and orders.

Uploaded by

hkgn6g7yvq
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
53 views5 pages

Documentatie API Emag Marketplace

The document outlines the process for proposing offers in campaigns and processing orders, detailing the required fields and constraints for each. It specifies the order statuses, properties, and various customer and product details necessary for order management. Additionally, it includes information on voucher discounts and cancellation reasons, providing a comprehensive guide for handling campaign offers and orders.

Uploaded by

hkgn6g7yvq
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

Proposing offers in campaigns

Key – level 1 Key – level 2 Description Constraints Example

not_available_post_cam If it`s not completed, the Optional. Integer value. 0 or 1. not_available_post_camp


paign offer will remain valid after aign=1
campaign end and if it`s
filled with "1", the offer will
no longer be active and valid
after campaign end.

Resource Example Context

http method: POST


campaign_proposals/save campaign_proposal
s.txt

5. Processing orders
An order consists of customer details, products and discounts from vouchers. It also has information about payment
method, shipping tax. Also, each order always has a status attached. The available statuses are:
0 – canceled
1 – new
2 – in progress
3 – prepared
4 – finalized
5 – returned
The resource is order and the available actions are read, save, count and acknowledge.

5.1. Order fields

An order has the following properties:

Key – level 1 Key – level 2 Description Constraints Example

id The number that uniquely Required. id=939393


identifies an order. Integer value
between 1 and
4294967295.

status The order processing Required. status=1


status. Possible values: Integer value
0 - cancelled between 0 and 5.
1 - new
2 - in progress
3 – prepared
4 - finalized
5 - returned

is_complete A flag indicating if the Optional. Integer is_complete=1


order is complete (has all value.

35
details necessary for
processing) or not.
Possible values:
0 - incomplete;
1 - complete.

type A flag indicating if the Optional. Integer type=3


order contains products value.
fulfilled by eMAG or by
seller. Possible values:
2 – fulfilled by eMAG
3 – fulfilled by seller

payment_mode_id The order payment Required. payment_mode_id=1


method. Possible values: Integer.
1 - COD (cash on delivery)
2 - bank transfer
3 - online card payment

detailed_payment_method The detailed order Optional. String. detailed_payment_method


payment method. = “eCREDIT”

delivery_mode The order delivery Optional. String. delivery_mode=”courier”


method. Possible values:
“courier” – home delivery
“pickup” – locker delivery

details Order extra details. Optional. Array.

details locker_id The pickup point id, if the Optional. String. locker_id=”dce0b7cf-dc38-
locker delivery option was 11e8-a7d8-001a4a160153”
selected by a customer.

locker_name The pickup point name, if Optional. String. locker_name=”easybox


the locker delivery option eMAG Showroom”
was selected by a
customer.

locker_delivery_eligible Indicates if the order, Optional. Integer locker_delivery_eligible=1


regardless of the delivery value.
method selected by the
customer, would fit into a
locker.
0 – not eligible for locker
delivery
1 – eligible for locker
delivery

courier_external_office_id The ID represents the Optional. String. courier_external_office_id=


identification of the
"183"
delivery point chosen by Should be used
the customer in the only by sellers
courier’s internal system included in the
(the courier which makes Door2Door
the last mile in Romania). China project

date The cart submission Optional. Text in date=”1970-01-01


timestamp. YYYY-mm-dd 23:59:59”
HH:ii:ss format.

36
modified The timestamp of the last Optional. Text in date=”1970-01-01
update on the order. YYYY-mm-dd 23:59:59”
HH:ii:ss format.

payment_status The payment status. Optional. It is payment_status=0


Possible values: highly
0 - not paid recommended
1 - paid to also interpret
the payment
status when
reading orders
with Card Online
payment
method. The key
is available for
both Card Online
and Cash on
delivery orders.
For COD,
payment_status
will be 0 until the
cashed amount
is received by
eMAG.

cashed_co The cashed amount from Optional.


Card online payment Integer.

cashed_cod The cashed amount from Optional.


cash on delivery payment Integer.

shipping_tax The shipment tax value. Optional. shipping_tax=”19.99”


Decimal.

shipping_tax_voucher_split A list of arrays describing List.


the voucher discounts
distribution on shipping
tax level.

voucher_id The ID of the voucher Optional. Integer voucher_id=123


discount value between 1
and 9999999.

value The value of the discount, Optional. value=-200


whitout VAT Negative value.

vat_value The value of the VAT Optional. Vat_value=-38


Negative value.

customer A list with the details Optional. List. The field list is detailed
about the customer, the below.
shipping and the billing
addresses.

products A list of arrays describing List. The field list is detailed


the products in the order. below.

attachments A list of arrays describing List. The field list is detailed


the attachments in the below (chapter 3.1.3).
order.

37
vouchers A list describing the List.
voucher discounts.

voucher_id The ID of the voucher Optional. Integer voucher_id=123


discount value between 1
and 9999999.

modified The modified date of the Optional. Text in modified="2015-04-23


voucher discount YYYY-mm-dd 11:30:09"
HH:ii:ss format.

created The date of the voucher Optional. Text in created="2015-04-23


discount YYYY-mm-dd 11:30:09"
HH:ii:ss format.

status The status of the voucher Optional. status=1


discount Integer.

sale_price_vat The value of the VAT Optional. sale_price_vat=”-1.9355"


Negative value.

sale_price The value of the discount, Optional. sale_price="-8.0645"


without VAT Negative value.

voucher_name The name of the voucher Optional. String. voucher_name="eMAG


giftcard"

vat The VAT rate Optional. vat="0.24"


Decimal.

issue_date The date when the Optional. Text in issue_date="2020-06-09"


voucher was issued YYYY-mm-dd
format.

is_storno Mandatory key when Optional. is_storno=true


products are returned for Boolean.
a finalized order. Further True indicates
details here. partial storno.

reason_cancellation The order cancellation Optional. Integer cancellation_reason=1


reason. Possible values: value between 1
and 5.
1 - Out of stock
2 - Cancelled by the client
3 - The client can not be
contacted
15 - Courier delivery term
is too large
16 - Transport tax, is too
large
17 - Large delivery term,
until the product will
arrive in our warehouse
18 - Better offer in
another store
19 - Payment order has
not been paid
20 - Undelivered order,
courier reasons
21 - Others

38
22 - Order Incomplete -
automatic cancellation
23 - The customer
changed his mind
24 - By customer request
25 - Failed delivery
26 - Late shipment
27 - Irrelevant Order
28 - Canceled by
SuperAdmin on seller
request
29 - Blacklisted customer
30 - No VAT invoice
31 - The eMAG
Marketplace partner
requested the order
cancellation
32 - The delivery
estimate is too long
33 - The product is no
longer available in the
stock of the eMAG
Marketplace partner
34 - Other reasons
35 - The delivery is too
expensive
36 - The customer found
a better price elsewhere
37 - The customer
registered another eMAG
order with a similar
product
38 - The customer
changed his mind, does
not need the product
39 - The customer can
purchase the product
only by installments
40 - Other reasons EIS
41 - Out of stock -
instalments
42 - The product is no
longer available in the
stock of the eMAG
Marketplace partner -
instalments
43 - The delivery
estimate is too long

enforced_vendor_courier_accounts List of the mandatory Optional. Array.


courier accounts that
must be used in AWB
issuing.

If null, you may use any


courier from your
available ones, if <> null
you must use one of the
ones from the array and
if it’s an empty array, you

39

You might also like