en:api_start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:api_start [2022/06/28 15:11]
simon
en:api_start [2022/06/28 15:32] (current)
simon
Line 622: Line 622:
 >//Operations with marketplaces// >//Operations with marketplaces//
 > >
->GET /marketplace Return all marketplaces - returns information on connected to the Client marketplaces+>GET /marketplace Return all marketplaces - Provides information about the connection to the customer marketplaces.
 > >
 >{{:ru:api_21.png?600|}} >{{:ru:api_21.png?600|}}
Line 636: Line 636:
 ---- ----
  
-====== Order ======+====== Orders ======
  
 >//Operations with orders// >//Operations with orders//
Line 649: Line 649:
 </WRAP> </WRAP>
 > >
->Get /order Returns order - is used for getting information on order+>Get /order Returns order - is used to receive information about the order.
 > >
 >{{:ru:api_22.png?600|}} >{{:ru:api_22.png?600|}}
Line 690: Line 690:
   -F 'ship_postal_code=28307 '</code>   -F 'ship_postal_code=28307 '</code>
 </WRAP> </WRAP>
->POST /order Create new order - is used for creating a new order+>POST /order Create new order - is used for the creation of a new order.
 > >
->id - order ID. If the box "Send empty value" is checked ID is generated automatically. +>id - order ID. If the box "Send empty value" is checked, the ID is generated automatically. 
 > >
->status_id - [[en:orderdescription|Status order ID]]. Check "Send empty value" box to set status automatically+>status_id - [[en:orderdescription|Status order ID]]. Check "Send empty value" box to set status automatically.
 > >
->company_id - [[en:comp|Company ID]] on ysell.pro+>company_id - [[en:comp|Company ID]] on ysell.pro.
 > >
->platform - platform that will be used for order creation+>platform - Platform used for order creation.
 > >
->platform_order_id - order Id on the platform+>platform_order_id - Order ID on the platform.
 > >
->purchase_date - order purchase date+>purchase_date - Order purchase date.
 > >
->payment_date - order payment date+>payment_date - Order payment date.
 > >
->latest_ship_date - the last time period for order sending +>latest_ship_date - The last period for sending the order. 
 > >
->currency - currency+>currency - Currency.
 > >
->ship_name - receiver'name+>ship_name - Recipient name.
 > >
->ship_email - receiver's email address+>ship_email - Recipient e-mail address.
 > >
->ship_addr1 - reciever'address +>ship_addr1 - Recipient address
 > >
->ship_city - receiver's city+>ship_city - Recipient City.
 > >
->ship_postal_code - receiver's postal code+>ship_postal_code - Recipient Postal Code.
 > >
->ship_country - receiver's country +>ship_country - Recipient Country.
 > >
->ship_phone_number - receiver'phone number+>ship_phone_number - Recipient phone number
  
 ---- ----
Line 733: Line 733:
   -H 'Authorization: Bearer '   -H 'Authorization: Bearer '
 </code> </code>
-//Getting information on the order with ID 75//+//Get information about the order with ID 75//
 </WRAP> </WRAP>
 >GET /order/{ID} Return order by ID - is used for return information on the order >GET /order/{ID} Return order by ID - is used for return information on the order
Line 750: Line 750:
   -H 'Authorization: Bearer '   -H 'Authorization: Bearer '
 </code> </code>
-//Getting information on the order with ID 75//+//Deleting the order with ID 75//
 </WRAP> </WRAP>
->Delete /order/{ID} Delete Order by ID - is used for order deleting+>Delete /order/{ID} Delete Order by ID - is used to delete orders.
 > >
 >ID - enter order ID >ID - enter order ID
Line 792: Line 792:
 } }
  </code>  </code>
-//Adding product to order with ID 70//+//Adding product to the order with ID 70//
 </WRAP> </WRAP>
->Post /order-item Create new order item - is used for adding position to the order+>Post /order-item Create new order item - is used for adding positions to the order.
 > >
->**order_id** - indicate order ID +>**order_id** - Enter order ID.
 > >
->**asin** - ASIN of the product+>**asin** - ASIN of the product.
 > >
->**p_id** - product ID+>**p_id** - Product ID.
 > >
->**product_name** - name of the product+>**product_name** - Name of the product.
 > >
->**sku** - SKU of the product+>**sku** - SKU of the product.
 > >
->**qty** - quantity of product in the order+>**qty** - Quantity of product in the order.
 > >
->**item_price** - price of a unit+>**item_price** - Price of a unit.
 >{{:ru:api_27.png?600|}} >{{:ru:api_27.png?600|}}
  
Line 841: Line 841:
   },   },
  </code>  </code>
-//Getting information on shipment 719-1//+//Information about shipment 719-1//
 </WRAP> </WRAP>
->**GET /prep-shipment Get prep shipment list** - используется получения информации о отправке с Преп-центра. is used for getting information on shipment from the Prep Center+>**GET /prep-shipment Get prep shipment list** -  is used to receive information about the shipment from the Prep Center.
 > >
->**company_id** - company ID+>**company_id** - Company ID.
 > >
->**shipment_num** - number of the shipment+>**shipment_num** - Number of the shipment.
 > >
->**shipment_type** - type of the shipment+>**shipment_type** - Type of the shipment.
 > >
->**shipment_type_description** - description of the shipment type+>**shipment_type_description** - Description of the shipment type.
 > >
->**status** - status of the shipment+>**status** - Status of the shipment.
 > >
->**status_description** - description of the shiment status+>**status_description** - Description of the shipment status.
 > >
->**total_cost** - price for the shipment processing+>**total_cost** - Price for processing the shipment.
 > >
->**declared_qty** - quantity of product units indicated by client+>**declared_qty** - Quantity of product units specified by the customer.
 > >
->**declared_box_qty** - quantity of boxes with product indicated by client+>**declared_box_qty** - Number of cartons with the product specified by the customer.
 > >
->**processed_qty** - quantity of product processed by the Prep Center+>**processed_qty** - Quantity of product processed by the Prep Center.
 > >
->**messages** - text of memo to shipment+>**messages** - Dispatch notification.
  
  
  
  • en/api_start.txt
  • Last modified: 2022/06/28 15:32
  • by simon