Types

Remote Orders

Statuses for remote orders

  • pending
  • processing
  • saled
  • cancelled
  • delivering
  • delivered
  • received
  • refund
  • arrived
  • Or your custom string

InfoType

Structure:

{
    "is_paid": bool,  // Paid?
    "payment_type": string,  // The name of the payment method that is accepted in your system
    // Optional
    "order_text": str  // alternative order_id as a pseudonym; only for display
}

OrderDataType

Structure:

[
    {
        "id": int,  // ID product in your system
        "name": string,  // Name product
        "product_id": int or null,  // "remote_id"; ID of the product, which is fixed in the HugeProfit system as an aid of the product on the marketplace. If the product is synchronized with the marketplace, then the indication of this key simplifies the finding of the product. It is recommended to leave this NULL field and use "local_product_id"
        "sku": string,  // article
        "quantity": float or int,  // quantity product in order
        "price": float or int,  // The price of one unit of goods
        "total": float or int,  // The amount of prices of all units of this product in this order
        "is_paid": bool,  // Paid?
        "payment_type": string,  // The name of the payment method that is accepted in your system
        // if this product in HugeProfit system
        "local_product_id": int  // ID product in HugeProfit system
    }
]

Note. If you know that this product exists in the Hugeprofit system, just specify the product ID in the field local_product_id.

RemoteAddressType

Structure:

{
    // Require
    "address_1": string,  // Actual delivery address
    "city": string,  // Delivery city
    "delivery_cost": int or float  // Delivery cost
    // Optional
    "ttn": string  // int-like string of delivery code
    "delivery_operator": string  // See options below
}

delivery_operator options:

  • nova_poshta
  • ukrposhta

SalesDataStructure

Default Statuses of sales

  • saled
  • reserve_sale
  • cod
  • delivery
  • delivering
  • on-delivering
  • refund
  • arrived