Service (1.0.0)

Download OpenAPI specification:Download

Called either by buyer or seller operator, this method returns the postal services (both domestic and international) provided by a certain origin operator

Request
path Parameters
token
required
string

The security token used to authorize the web method call

origOperator
required
string

The origin operator providing the postal services to the destination operator (i.e. AUA, FRA, USA)

destOperator
required
string

The destination operator (i.e. AUA, FRA, USA)

Responses
default

List of international postal services

get/GetPostalServices/{token}/{origOperator}/{destOperator}
Response samples
application/json
[
  • {
    }
]

Called either by buyer or seller operator, this method returns the marketed goods (both domestic and international) that can be bought on the buyer side.

Request
path Parameters
token
required
string

The security token used to authorize the web method call

sellerOperator
required
string

Operator on the seller side, the seller operator (i.e. AUA, FRA, USA)

buyerOperator
required
string

Operator on the buyer side, the buyer operator (i.e. AUA, FRA, USA)

Responses
default

List of goods that can be comercialized at the buyer side

get/GetMarketedGoods/{token}/{sellerOperator}/{buyerOperator}
Response samples
application/json
[
  • {
    }
]

Called by operator on seller's side, this method creates a new marketed good.

Request
path Parameters
token
required
string

The security token used to authorize the web method call

Request Body schema: application/json

Details of comercialized goods

Buyer_operators
Array of strings or null
Description
string or null
FreeOfChargeReturn
boolean
Good_details
string or null
HS_code
string or null
Height_cm
number or null
Length_cm
number or null
Picture
string or null
object or null (TValue_type_q1)
Reference_id
integer or null <int32>
Seller_address
string or null
Seller_city
string or null
Seller_country
string or null
Seller_name
string or null
Seller_operator
string or null
Seller_phone
string or null
Seller_ref_id
string or null
Seller_zip
string or null
Service_description
string or null
Stock
integer or null <int32>
Valid_from
string or null <date-time>
Valid_to
string or null <date-time>
Weight_kg
number or null
Width_cm
number or null
Responses
default

Whether operation executed successfully or not

post/SellerCreateMarketedGood/{token}
Request samples
application/json
{
  • "Buyer_operators": [
    ],
  • "Description": "string",
  • "FreeOfChargeReturn": true,
  • "Good_details": "string",
  • "HS_code": "string",
  • "Height_cm": 0,
  • "Length_cm": 0,
  • "Picture": "string",
  • "Price": {
    },
  • "Reference_id": 0,
  • "Seller_address": "string",
  • "Seller_city": "string",
  • "Seller_country": "string",
  • "Seller_name": "string",
  • "Seller_operator": "string",
  • "Seller_phone": "string",
  • "Seller_ref_id": "string",
  • "Seller_zip": "string",
  • "Service_description": "string",
  • "Stock": 0,
  • "Valid_from": "2019-08-24T14:15:22Z",
  • "Valid_to": "2019-08-24T14:15:22Z",
  • "Weight_kg": 0,
  • "Width_cm": 0
}
Response samples
application/json
{
  • "ErrorCode": "string",
  • "ErrorDetails": "string",
  • "Successful": true
}

Called by the operator on buyer's side in case of domestic shipping, this method returns the prohibitions and restrictions applied at the destination (import customs) to a particular origin country and good.

Request
path Parameters
token
required
string

The security token used to authorize the web method call

origCountry
required
string

Origin ISO country code (i.e. CA, BR, IT)

destOperator
required
string

Destination operator (i.e. AUA, FRA, USA)

goodDescription
required
string

Good description (i.e. t-shirt,shoes)

goodHS
required
string

Good HS code (i.e. 620590, 640110)

Responses
default

List of prohibitions and restrictions

get/GetImpProhibitionsRestrictions/{token}/{origCountry}/{destOperator}/{goodDescription}/{goodHS}
Response samples
application/json
[
  • {
    }
]

Called either by buyer or seller operator, this method returns the HS code corresponding to the description of good

Request
path Parameters
token
required
string

The security token used to authorize the web method call

goodDescription
required
string

Good description (i.e. t-shirt,shoes)

Responses
default

The HS code matching the good description

get/GetHSCodes/{token}/{goodDescription}
Response samples
application/json
[
  • {
    }
]

Called by operator on buyer's side, this method creates a commercial order associated to a payment order from buyer to seller. If international, the order is made available to the seller through CDS.PEG. When indicated, an IFS money order (international or domestic) is created from buyer post to seller post.

Request
path Parameters
token
required
string

The security token used to authorize the web method call

Request Body schema: application/json

Order details

object or null (TValue_type_q1)
object or null (TParty_type_q1)
COD_indicator
boolean
object or null (TValue_type_q1)
Array of objects or null (TContentPiece_type_q1)
object or null (TDeliveryService_type_q1)
Dest_operator
string or null
IFS_payment
boolean
object or null (TMail_type_q1_nil)
Array of objects or null (TMail_type_q1)
Order_date
string <date-time>
Order_id
string or null
object or null (TOrderPayment_type_q1_nil)
Array of objects or null (TOrderPayment_type_q1)
Order_state
integer or null <int32> [ 0 .. 255 ]
Orig_operator
string or null
object or null (TValue_type_q1)
object or null (TPostalService_type_q1_nil)
object or null (TReturnService_type_q1)
object or null (TParty_type_q1)
Transaction_purchase_order_number
string or null
Transaction_sales_order_number
string or null
Responses
default

Whether operation executed successfully or not

post/BuyerCreateOrder/{token}
Request samples
application/json
{
  • "Additional_fees": {
    },
  • "Buyer": {
    },
  • "COD_indicator": true,
  • "Commercial_value": {
    },
  • "Content_pieces": [
    ],
  • "Delivery_service": {
    },
  • "Dest_operator": "string",
  • "IFS_payment": true,
  • "Mail_fulfilment": {
    },
  • "Mail_return": [
    ],
  • "Order_date": "2019-08-24T14:15:22Z",
  • "Order_id": "string",
  • "Order_payment": {
    },
  • "Order_refund": [
    ],
  • "Order_state": 255,
  • "Orig_operator": "string",
  • "Postage_paid": {
    },
  • "Postal_service_paid": {
    },
  • "Return_service": {
    },
  • "Seller": {
    },
  • "Transaction_purchase_order_number": "string",
  • "Transaction_sales_order_number": "string"
}
Response samples
application/json
{
  • "ErrorCode": "string",
  • "ErrorDetails": "string",
  • "Successful": true
}

Called by operator on seller's side, this method retrieves the international commercial orders destined to a particular seller

Request
path Parameters
token
required
string

The security token used to authorize the web method call

Request Body schema: application/json

Seller details

Alternate_address_line
string or null
Alternate_city_town
string or null
Alternate_house_identifier
string or null
Alternate_postcode
string or null
Contact_digital_signature
string or null
Contact_email
string or null
Contact_fax
string or null
Contact_name
string or null
Contact_telephone
string or null
House_identifier
string or null
Identification_additional_data
string or null
Identification_name
string or null
Identification_postal_certificate_number
string or null
Identification_reference
string or null
Language
string or null
Postal_address_country_code
string or null
Postal_address_locality_code
string or null
Postal_address_locality_name
string or null
Postal_address_locality_region
string or null
Postal_address_premises
string or null
Responses
default
post/SellerGetIntOrders/{token}
Request samples
application/json
{
  • "Alternate_address_line": "string",
  • "Alternate_city_town": "string",
  • "Alternate_house_identifier": "string",
  • "Alternate_postcode": "string",
  • "Contact_digital_signature": "string",
  • "Contact_email": "string",
  • "Contact_fax": "string",
  • "Contact_name": "string",
  • "Contact_telephone": "string",
  • "House_identifier": "string",
  • "Identification_additional_data": "string",
  • "Identification_name": "string",
  • "Identification_postal_certificate_number": "string",
  • "Identification_reference": "string",
  • "Language": "string",
  • "Postal_address_country_code": "string",
  • "Postal_address_locality_code": "string",
  • "Postal_address_locality_name": "string",
  • "Postal_address_locality_region": "string",
  • "Postal_address_premises": "string"
}
Response samples
application/json
[
  • {
    }
]

Called by operator on seller's side, this method prepares all necessary shipping documents (i.e. label CN04, customs forms CN22, CN23, etc). If mail item S10 ID is not provided in the calling parameter, the system will obtain a S10 item ID automatically and print a CN04 form

Request
path Parameters
token
required
string

The security token used to authorize the web method call

Request Body schema: application/json

Order details for which shipping is prepared

object or null (TValue_type_q1)
object or null (TParty_type_q1)
COD_indicator
boolean
object or null (TValue_type_q1)
Array of objects or null (TContentPiece_type_q1)
object or null (TDeliveryService_type_q1)
Dest_operator
string or null
IFS_payment
boolean
object or null (TMail_type_q1_nil)
Array of objects or null (TMail_type_q1)
Order_date
string <date-time>
Order_id
string or null
object or null (TOrderPayment_type_q1_nil)
Array of objects or null (TOrderPayment_type_q1)
Order_state
integer or null <int32> [ 0 .. 255 ]
Orig_operator
string or null
object or null (TValue_type_q1)
object or null (TPostalService_type_q1_nil)
object or null (TReturnService_type_q1)
object or null (TParty_type_q1)
Transaction_purchase_order_number
string or null
Transaction_sales_order_number
string or null
Responses
default

List of shipping forms

post/SellerPrepareShipping/{token}
Request samples
application/json
{
  • "Additional_fees": {
    },
  • "Buyer": {
    },
  • "COD_indicator": true,
  • "Commercial_value": {
    },
  • "Content_pieces": [
    ],
  • "Delivery_service": {
    },
  • "Dest_operator": "string",
  • "IFS_payment": true,
  • "Mail_fulfilment": {
    },
  • "Mail_return": [
    ],
  • "Order_date": "2019-08-24T14:15:22Z",
  • "Order_id": "string",
  • "Order_payment": {
    },
  • "Order_refund": [
    ],
  • "Order_state": 255,
  • "Orig_operator": "string",
  • "Postage_paid": {
    },
  • "Postal_service_paid": {
    },
  • "Return_service": {
    },
  • "Seller": {
    },
  • "Transaction_purchase_order_number": "string",
  • "Transaction_sales_order_number": "string"
}
Response samples
application/json
[
  • {
    }
]

Called by operator on buyer's side, this method prepares a return label (if return service allowed)

Request
path Parameters
token
required
string

The security token used to authorize the web method call

Request Body schema: application/json

Order details

object or null (TValue_type_q1)
object or null (TParty_type_q1)
COD_indicator
boolean
object or null (TValue_type_q1)
Array of objects or null (TContentPiece_type_q1)
object or null (TDeliveryService_type_q1)
Dest_operator
string or null
IFS_payment
boolean
object or null (TMail_type_q1_nil)
Array of objects or null (TMail_type_q1)
Order_date
string <date-time>
Order_id
string or null
object or null (TOrderPayment_type_q1_nil)
Array of objects or null (TOrderPayment_type_q1)
Order_state
integer or null <int32> [ 0 .. 255 ]
Orig_operator
string or null
object or null (TValue_type_q1)
object or null (TPostalService_type_q1_nil)
object or null (TReturnService_type_q1)
object or null (TParty_type_q1)
Transaction_purchase_order_number
string or null
Transaction_sales_order_number
string or null
Responses
default

List of shipping forms

post/BuyerPrepareReturn/{token}
Request samples
application/json
{
  • "Additional_fees": {
    },
  • "Buyer": {
    },
  • "COD_indicator": true,
  • "Commercial_value": {
    },
  • "Content_pieces": [
    ],
  • "Delivery_service": {
    },
  • "Dest_operator": "string",
  • "IFS_payment": true,
  • "Mail_fulfilment": {
    },
  • "Mail_return": [
    ],
  • "Order_date": "2019-08-24T14:15:22Z",
  • "Order_id": "string",
  • "Order_payment": {
    },
  • "Order_refund": [
    ],
  • "Order_state": 255,
  • "Orig_operator": "string",
  • "Postage_paid": {
    },
  • "Postal_service_paid": {
    },
  • "Return_service": {
    },
  • "Seller": {
    },
  • "Transaction_purchase_order_number": "string",
  • "Transaction_sales_order_number": "string"
}
Response samples
application/json
[
  • {
    }
]

Called by operator on seller's side, this method creates a refund payment for a return item

Request
path Parameters
token
required
string

The security token used to authorize the web method call

Request Body schema: application/json

Order details

object or null (TValue_type_q1)
object or null (TParty_type_q1)
COD_indicator
boolean
object or null (TValue_type_q1)
Array of objects or null (TContentPiece_type_q1)
object or null (TDeliveryService_type_q1)
Dest_operator
string or null
IFS_payment
boolean
object or null (TMail_type_q1_nil)
Array of objects or null (TMail_type_q1)
Order_date
string <date-time>
Order_id
string or null
object or null (TOrderPayment_type_q1_nil)
Array of objects or null (TOrderPayment_type_q1)
Order_state
integer or null <int32> [ 0 .. 255 ]
Orig_operator
string or null
object or null (TValue_type_q1)
object or null (TPostalService_type_q1_nil)
object or null (TReturnService_type_q1)
object or null (TParty_type_q1)
Transaction_purchase_order_number
string or null
Transaction_sales_order_number
string or null
Responses
default

Whether operation executed successfully or not

post/SellerRefundBuyer/{token}
Request samples
application/json
{
  • "Additional_fees": {
    },
  • "Buyer": {
    },
  • "COD_indicator": true,
  • "Commercial_value": {
    },
  • "Content_pieces": [
    ],
  • "Delivery_service": {
    },
  • "Dest_operator": "string",
  • "IFS_payment": true,
  • "Mail_fulfilment": {
    },
  • "Mail_return": [
    ],
  • "Order_date": "2019-08-24T14:15:22Z",
  • "Order_id": "string",
  • "Order_payment": {
    },
  • "Order_refund": [
    ],
  • "Order_state": 255,
  • "Orig_operator": "string",
  • "Postage_paid": {
    },
  • "Postal_service_paid": {
    },
  • "Return_service": {
    },
  • "Seller": {
    },
  • "Transaction_purchase_order_number": "string",
  • "Transaction_sales_order_number": "string"
}
Response samples
application/json
{
  • "ErrorCode": "string",
  • "ErrorDetails": "string",
  • "Successful": true
}

Called either by buyer or seller operator, this method retrieves all information available for an order

Request
path Parameters
token
required
string

The security token used to authorize the web method call

id
required
string

Identifier (order Id, mail item Id or payment Id)

language
required
string

ISO language code (i.e. EN, FR, DE)

Responses
default

List or orders matching the id passed as parameter

get/Track/{token}/{id}/{language}
Response samples
application/json
[
  • {
    }
]

Called either by buyer or seller operator, this method provides the current server version of the eCom API

Responses
default

Current server version

get/CurrentServerVersion
Response samples
application/json
0
0

Called either by buyer or seller operator, this method provides the current proxy version of the eCom API

Responses
default

Current proxy version

get/CurrentProxyVersion
Response samples
application/json
{ }