| Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
en:api_start [2022/06/28 14:59]
simon |
en:api_start [2022/06/28 15:32]
simon |
| ---- | ---- |
| |
| > Enter /Supplier to create a new supplier | > POST /Supplier to create a new supplier |
| > | > |
| > Specify supplier name. Supplier ID will be assigned automatically | > Specify supplier name. Supplier ID will be assigned automatically |
| } | } |
| </code> | </code> |
| //Getting information on product ID by number "322"// | //Retrieve information about the product ID with the number "322// |
| </WRAP> | </WRAP> |
| > | > |
| > | > |
| > | > |
| >GET /supplier/{supplierNum}/product Find product by supplier num - is used for returning ID information by Supplier number | >GET /supplier/{supplierNum}/product Find product by supplier num - is used for returning ID information by supplier number. |
| > | > |
| >{{:ru:api_14.png?750|}} | >{{:ru:api_14.png?750|}} |
| //Updating information on the Supplier with ID "3"// | //Updating information on the Supplier with ID "3"// |
| </WRAP> | </WRAP> |
| >PUT /supplier/{supplierID} Update Supplier - is used for information editing on Supplier | > GET /supplier/{supplierID} Update Supplier - for information editing on Supplier. |
| > | > |
| >**supplierId** - specify supplier ID | >**supplierId** - specify supplier ID |
| }' | }' |
| </code> | </code> |
| //Supplier deleting with ID "3"// | //Deletion of the supplier with ID "3// |
| </WRAP> | </WRAP> |
| > | > |
| >Delete /supplier/{supplierID} - is used for deleting information about Supplier | >Delete /supplier/{supplierID} - is used to delete information about suppliers. |
| >**supplierId** - Supplier ID | >**supplierId** - Supplier ID |
| >{{:ru:api_16.png?600|}} | >{{:ru:api_16.png?600|}} |
| ] | ] |
| </code> | </code> |
| //Getting information on Manufacturers from Client// | //Receive information about the manufacturer from the customer// |
| </WRAP> | </WRAP> |
| |
| } | } |
| </code> | </code> |
| //Manufacturer creating "NewManufacturer"// | //Manufacturer created "NewManufacturer"// |
| </WRAP> | </WRAP> |
| > | > |
| >Post /maufacturer Create new Manufacturer | >POST /maufacturer Create new Manufacturer |
| > | > |
| >Enter a name of Manufacturer in the "Name" field. ID of Manufacturer will be assigned automatically. | >Enter a name of Manufacturer in the "Name" field. ID of Manufacturer will be assigned automatically. |
| </code> | </code> |
| |
| //Information updating on Manufacturer with name "NewManufacturer2"// | //Updating the information about the manufacturer named "NewManufacturer2"// |
| </WRAP> | </WRAP> |
| >PUT /manufacturer/{manufacturerID} Update Manufacturer - is used for information editing on Manufacturer | >PUT /manufacturer/{manufacturerID} Update Manufacturer - Updating the information about the manufacturer named "NewManufacturer2". |
| > | > |
| >manufacturerId - specify Manufacturer ID | >manufacturerId - specify Manufacturer ID. |
| >Specify name of Manufacturer in the "Name" field. | >Specify the name of the Manufacturer in the "Name" field. |
| > | > |
| >{{:ru:api_19.png?700|}} | >{{:ru:api_19.png?700|}} |
| -H 'Authorization: Bearer ' | -H 'Authorization: Bearer ' |
| </code> | </code> |
| //Information deleting about Manufacturer with ID "22"// | //Deleting information about the manufacturer with ID "22"// |
| </WRAP> | </WRAP> |
| |
| >//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|}} |
| ---- | ---- |
| |
| ====== Order ====== | ====== Orders ====== |
| |
| >//Operations with orders// | >//Operations with orders// |
| </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|}} |
| -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's name | >ship_name - Recipient name. |
| > | > |
| >ship_email - receiver's email address | >ship_email - Recipient e-mail address. |
| > | > |
| >ship_addr1 - reciever's 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's phone number | >ship_phone_number - Recipient phone number |
| |
| ---- | ---- |
| -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 |
| -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 |
| } | } |
| </code> | </code> |
| //Adding product to order with ID 70// | //Adding a 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|}} |
| |
| }, | }, |
| </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. |
| |
| |
| |