Platform Orders

Create/Update an order

POST https://northapi.com/api/v2/platform/{uuid}/order

Parameters: UUID: the platform uuid found in AfterSalesPro panel or sent to you via email.

Notice: When an order with the same primary_id exists, it will be updated, otherwise a new order will be created.

Parameter Type Default Description
primary_id string [Required] - [Unique] - Main id for reference
secondary_id string Secondary id for reference
status string [Required] - Order status
payment_method string [Required] - Payment method (code)
payment_label string Payment method label (friendly name)
shipping_method string [Required] - Shipping method (code)
shipping_label string Shipping method label (friendly name)
shipping_charge decimal Shipping charge
cod_total decimal Cash on Delivery charge
order_total decimal [Required] - Order total
currency string i.e EUR, USD etc.
customer_id string Customer unique id
recipient_firstname time [Required] - Customer First Name
recipient_lastname time [Required] - Customer Last Name
recipient_company time Customer Company name
recipient_address_str string Recipient address street
recipient_zipcode string [Required] - Recipient ZipCode
recipient_city string [Required] - Recipient city
recipient_region string [Required] - Recipient region
recipient_country string [Required] - Recipient country, i.e.
recipient_phone string Recipient Landline phone number
recipient_mobile string Recipient Mobile number (used for SMS, too)
items integer Total qty ordered
weight decimal Order total weight
platform_created_at datetime [Required] - DateTime of order creation date, format YYYY-MM-DD HH:MM:SS
platform_updated_at datetime [Required] - DateTime of order last update, format YYYY-MM-DD HH:MM:SS
notes string Order notes

Response

{
  "success": true,
  "message": "Order saved.",
  "data": {
    "primary_id": "2001",
    "secondary_id": null,
    "status": "pending",
    "weight": "2",
    "items": "4",
    "payment_method": "cod",
    "shipping_method": "acs",
    "shipping_label": "ACS Courier",
    "shipping_charge": "0.00",
    "cod_total": "15.65",
    "order_total": "15.65",
    "currency": "EUR",
    "notes": "Test comments",
    "customer_id": null,
    "recipient_firstname": "Name",
    "recipient_lastname": "Surname",
    "recipient_company": null,
    "recipient_address_str": "Address 15",
    "recipient_zipcode": "16566",
    "recipient_city": "Glyfada",
    "recipient_region": "Attiki",
    "recipient_country": "GR",
    "recipient_phone": "2101234567",
    "recipient_mobile": null,
    "platform_created_at": "2020-05-26 15:53:11",
    "platform_updated_at": "2020-05-26 15:53:11"
  }
}