API - Marketplaces API list

/marketplaces/

  • This endpoint of the Lengow API allows you to display the complete list of possible actions authorized by a marketplace. 
  • It also gives access to the list of authorized carriers by the marketplace 
  • You can also see the list of authorized statuses by the marketplace 
Exemple: /marketplaces/?marketplace=laredoute
-- example with Laredoute marketplace --

-- action "ship" --

{
"laredoute": {
"logo": null,
"name": "LaRedoute",
"orders": {
"status": {
"refused": [
"Refused"
],
"shipped": [
"Shipped"
],
"accepted": [
"Accepted"
],
"canceled": [
"Cancelled",
"OutOfStock"
],
"refunded": [
"Refunded"
],
"refunding": [
"Refunding"
],
"waiting_shipment": [
"ToShip"
],
"waiting_acceptance": [
"Created"
]
},
"actions": {
"ship": {
"args": [
"carrier",
"tracking_number"
],
"status": [
"waiting_shipment"
],
"optional_args": [
"line",
"tracking_url"
],
"args_description": {
"line": {
"type": "line_number",
"valid_values": {},
"default_value": null,
"accept_free_values": true
},
"carrier": {
"type": "string",
"valid_values": {},
"default_value": "",
"accept_free_values": true
},
"tracking_url": {
"type": "string",
"valid_values": {},
"default_value": null,
"accept_free_values": true
},
"tracking_number": {
"type": "string",
"valid_values": {},
"default_value": null,
"accept_free_values": true
}
}
},

"actions": 
{ "ship": 
{ "args": [ "carrier", "tracking_number" ],
"status": [ "waiting_shipment" ],
"optional_args": [ "line", "tracking_url" ],

LaRedoute enables the "ship" action, but this action will be valid ONLY IF
  • if the "carrier" and "tracking_number" parameters are completed as they are mandatory. 
  • if the order is in the "waiting_shipment" status
Use the &marketplace parameter to call a specific marketplace.    
Was this article helpful?
0 out of 0 found this helpful
-

Articles in this section

Our Support hours:
9 a.m. to 6:30 p.m. CET Monday through Friday