AddOrder

Adding a new order.

  • Input data type => object
  • Output data type => object

Input parameters

  1. currency (string)

    Required. Currency. Standard ISO 4217.

  2. user (OrderUserType)

    Required.

  3. delivery (OrderDeliveryType)

    Required. Delivery.

  4. payments (ArrayOfOrderPaymentType - array of OrderPaymentType)

    Required. Payments.

  5. products (ArrayOfOrderProductType - array of OrderProductType)

    Required. Products.

  6. is_confirmed (boolean)

    Is the order confirmed? Default: false

  7. status_id (integer)

    Order status identifier.

  8. client_request_invoice (boolean)

    Request for invoice

  9. merchant_notes (string)

    Merchant notes.

Output data

  1. id (integer)

    2. Identifier of the created order.

Data types

OrderUserType Customer data. Parameters:

OrderUserDataType Customer address data. Parameters:

  • company (string)

    Company name.

  • full_name (string)

    First and last name.

  • address (string)

    Required. Address.

  • address_more (string)

    Further address.

  • country (string)

    Required. Country code. ISO 3166-1 alpha-2 standard.

  • zip_code (string)

    Required. Zip code.

  • town (string)

    Required. Town.

  • phone (string)

    Phone.

  • vat_number (string)

    VAT number.

OrderDeliveryType Delivery. Parameters:

  • delivery_id (integer)

    Required. Delivery identifier.

  • is_weekend_delivery (boolean)

    Delivery on weekend? Default: false

  • is_express_delivery (boolean)

    Express delivery? Default: false

  • tracking_numbers (ArrayOfString)

    Shipment tracking number.

OrderPaymentType Payment. Parameters:

  • payment_type_id (integer)

    Required. Payment type identifier.

  • amount (double)

    Amount. Default: total order value.

  • is_paid (boolean)

    Paid? Default: false.

OrderProductType Product. Parameters:

  • product_id (integer)

    Required. Product identifier.

  • quantity (double)

    Quantity.

  • options (ArrayOfInteger)

    Product option identifier.

  • discount (OrderProductDiscountType)

    Discount.

OrderProductDiscountType Product discount. Parameters:

  • value (double)

    Required. Discount value.

  • type (string)

    Discount type. Default: %.

    • % - percentage
    • p - amount