Show/hide List Operations Expand Operations

Awb

POST /api/v1/pmt-receipts/save

Api for saving Postal Money Transfer receipts

Documentation
Sandbox

Status Codes

Status Code	Description
204	Successful
403	Unauthorized
400	Bad request
500	Internal server error

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Claims & Messaging

GET /api/v1/claims-messaging/attachment/{id}

Download attachment by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	[0-9]+

Status Codes

Status Code	Description
200	Ok
401	Authentication required
400	Bad request
403	Forbidden
500	Internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v1/claims-messaging/attachment/{id}

Post new attachment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	[0-9]+

Parameters

Parameter	Type	Required?	Format	Description
attachment	File	true		Content

Status Codes

Status Code	Description
201	Created
401	Authentication required
400	Bad request
403	Forbidden
500	Internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/case/{caseType}/{id}

Get Thread|Thread AM|Claim by caseType (thread|thread-am|claim) and id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
caseType	claim\|thread\|thread-am
id	[0-9]+

Status Codes

Status Code	Description
200	OK
401	Authentication required
400	Bad request
403	Forbidden
500	Internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v1/claims-messaging/comment/{caseType}/{id}

Post new comment

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
caseType	claim\|thread\|thread-am
id	[0-9]+

Parameters

Parameter	Type	Required?	Format	Description
content		true		Content

Status Codes

Status Code	Description
201	commentId: commentId
401	Authentication required
400	Bad request
403	Forbidden
500	Internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/counter

Claims Counter. Response example: {'code': 200,'count': 8}

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
counterType	Choice		Type of the counter (claims\|messages)

Status Codes

Status Code	Description
200	OK
401	Authentication required
400	Bad request
500	Internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/list

Claims List.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
limit	Range		Pagination Limit

Filters

Name

Information

id

Requirement	GreaterThan
Description	Case ID

status

Requirement	Choice[]
Description	Marketplace Status (New\|Pending\|Answered\|Resolved\|Irrelevant)

severity

Requirement	Choice[]
Description	Marketplace Severity (Low\|High\|Critical)

needsResponse

Requirement	EqualTo
Description	Claim\/ Message needs response from seller (1)

offset

Requirement	GreaterThan
Description	Pagination Offset

createdDate

Requirement	DateTime
Description	Created date. Default current date

orderWay

Requirement	Choice
Description	createdAt sort order(ASC\|DESC)

hasIncidents

Requirement	Choice
Description	hasIncidents boolean (0\|1)

caseType

Requirement	Choice
Description	Case type (claim\|thread\|thread-am)

Status Codes

Status Code	Description
200	OK
401	Authentication required
400	Bad request
500	Internal server error

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/types-topics

Claims Types and Topics

Documentation
Sandbox

Filters

Name

Information

caseType

Requirement	Choice
Description	Case type (claim\/thread\/thread-am)

activeTypes

Requirement	Choice
Description	Get only active types (0\|1)

Status Codes

Status Code	Description
200	OK
401	Authentication required
400	Bad request
500	Internal server error

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Commission

GET /api/v1/commission/estimate/{extId}

Estimate commission. Response ex.: {code: 200,data: {value: 22.0000,id: 10145378,created: 2019-07-03 17:27:22,end_date: null}

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
extId	\d+	int

Status Codes

Status Code	Description
200	OK
401	Authentication required
400	Bad request
500	Internal server error
404	Not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Order

POST DEPRECATED /api/v1/order/{orderId}/product

This api can be called with an order ID and other mandatory parameters to add a product to the order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
orderId		int	Mkt Id

Parameters

Parameter	Required?	Description
product_id	true	Seller internal product id
quantity	true	quantity
sale_price	true	sale price
vat	false	vat rate
name	false	product ext name
part_number	false	product part number

Status Codes

Status Code	Description
200	Successful
403	Unauthorized
404	If seller, order, product was not found
405	Not Allowed - with message for errors
400	Bad request
500	Internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE DEPRECATED /api/v1/order/{orderId}/product/{id}

This api can be called with an order ID and an order line ID to delete the product from the order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
orderId		int	Mkt Id
id		int	eMAG internal order product line id

Status Codes

Status Code	Description
200	Successful
403	Unauthorized
404	If seller, order, product was not found
405	Not Allowed - with message for errors
500	Internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT DEPRECATED /api/v1/order/{orderId}/product/{id}

This api can be called with an order ID, an order line ID and other parameters to update a product from the order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
orderId		int	Mkt Id
id		int	eMAG internal order product line id

Parameters

Parameter	Type	Required?	Format	Description
quantity		true		quantity

Status Codes

Status Code	Description
200	Successful
403	Unauthorized
404	If seller, order, product was not found
405	Not Allowed - with message for errors
500	Internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v2/order/{orderId}/{type}/product

This api can be called with an order ID and other mandatory parameters to add a product to the order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
orderId		int	Mkt Id
type	\d+	int

Parameters

Parameter	Required?	Description
product_id	true	Seller internal product id
quantity	true	quantity
sale_price	true	sale price
vat	false	vat rate
name	false	product ext name
part_number	false	product part number

Status Codes

Status Code	Description
200	Successful
403	Unauthorized
404	If seller, order, product was not found
405	Not Allowed - with message for errors
400	Bad request
500	Internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/v2/order/{orderId}/{type}/product/{id}

This api can be called with an order ID and an order line ID to delete the product from the order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
orderId		int	Mkt Id
id		int	eMAG internal order product line id
type	\d+	null

Status Codes

Status Code	Description
200	Successful
403	Unauthorized
404	If seller, order, product was not found
405	Not Allowed - with message for errors
500	Internal server error

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/v2/order/{orderId}/{type}/product/{id}

This api can be called with an order ID, an order line ID and other parameters to update a product from the order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
orderId		int	Mkt Id
id		int	eMAG internal order product line id
type	\d+	null

Parameters

Parameter	Type	Required?	Format	Description
quantity		true		quantity

Status Codes

Status Code	Description
200	Successful
403	Unauthorized
404	If seller, order, product was not found
405	Not Allowed - with message for errors
500	Internal server error

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Products

GET /api/v1/product/search-by-ean

This api must be called with EAN and will return all ext_ids belonging to the seller

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
ean	string	false		Offer EAN

Status Codes

Status Code	Description
200	Successful
500	Internal server error

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

API documentation

Awb

POST /api/v1/pmt-receipts/save

Status Codes

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Claims & Messaging

GET /api/v1/claims-messaging/attachment/{id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v1/claims-messaging/attachment/{id}

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/case/{caseType}/{id}

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/v1/claims-messaging/comment/{caseType}/{id}

Requirements

Parameters

Status Codes

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/counter

Requirements

Status Codes

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/list

Requirements

Filters

Status Codes

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/v1/claims-messaging/types-topics

Filters

Status Codes

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Commission