Shipments

In this page we desribe the following scenario

  1. Retrieve shipment list for a specific date
  2. Retrieve a shipment
  3. Create a shipment
  4. Retrieve a shipment's tracking statuses

1. Retrieve shipment list for a specific date

Each page contains 20 rows.

GET https://northapi.com/api/v2/shipment/?date=YYYY-MM-DD

Parameters: YYYY-MM-DD: the creation date for the shipments will be returned.

Response

{
    "success": true,
    "message": "",
    "pagination": {
        "total_rows": 220,
        "next_page_url": "https://northapi.com/api/v1/shipment/2019-12-17?page=10",
        "prev_page_url": https://northapi.com/api/v1/shipment/2019-12-17?page=9,
        "total_pages": 11
    },
    "data": [
        {
            "uuid": "UUID",
            "pickup_date": "02-11-2020",
            "generated_at": "2021-02-03T12:08:59.000000Z",
            "printed_at": "2021-02-03T12:15:18.000000Z",
            "sent_at": "2021-02-03T12:15:18.000000Z",
            "delivered_at": "2021-02-04T14:37:00.000000Z",
            "paid_at": "2021-03-19T08:20:29.000000Z",
            "returned_at": null,
            "cancelled_at": null,
            "delivery_time": null,
            "dispatcher_name": "Company",
            "recipient_name": "John Doe",
            "recipient_company": null,
            "recipient_address_str": "Vouliagmenis 32",
            "recipient_address_num": null,
            "recipient_area": "Attiki, Athens",
            "recipient_phone": null,
            "recipient_mobile": "6901234567",
            "recipient_zipcode": "12345",
            "recipient_country": null,
            "recipient_floor": null,
            "items": 1,
            "weight": "1.00",
            "is_saturday": false,
            "is_reception": false,
            "is_protocol": false,
            "is_return_doc": false,
            "is_package_return": 0,
            "is_cod": true,
            "cod_total": "90.70",
            "order_total": "90.70",
            "our_charge": true,
            "related_id": "123",
            "related_id_secondary": null,
            "notes": "Order id: 100010653",
            "voucher_number": "700000012345",
            "message": "Εγινε Παράδοση Στον Παραλήπτη",
            "is_risky": false,
            "sent_to_provider": true,
            "sms_enabled": true,
            "sms_sent": 1,
            "sms_sent_at": "2021-02-03T19:01:46.000000Z",
            "tracked_at": "2021-02-04 17:25:28",
            "created_at": "2021-02-03T12:08:57.000000Z",
            "agency": "acs_courier",
            "tracking_url": "https://www.acscourier.net/el/track-and-trace",
            "shipping_agency_id": "UUID",
            "platform_id": "UUID"
        },
        {
            ...
        }
    ]
}

2. Retrieve a shipment

GET https://northapi.com/api/v2/shipment/UUID

Parameters: UUID: is returned when creating a new shipment.

Response

{
  "success": true,
  "message": "",
  "data": {
        "uuid": "UUID",
        "pickup_date": "02-11-2020",
        "generated_at": "2021-02-03T12:08:59.000000Z",
        "printed_at": "2021-02-03T12:15:18.000000Z",
        "sent_at": "2021-02-03T12:15:18.000000Z",
        "delivered_at": "2021-02-04T14:37:00.000000Z",
        "paid_at": "2021-03-19T08:20:29.000000Z",
        "returned_at": null,
        "cancelled_at": null,
        "delivery_time": null,
        "dispatcher_name": "Company",
        "recipient_name": "John Doe",
        "recipient_company": null,
        "recipient_address_str": "Vouliagmenis 32",
        "recipient_address_num": null,
        "recipient_area": "Attiki, Athens",
        "recipient_phone": null,
        "recipient_mobile": "6901234567",
        "recipient_zipcode": "12345",
        "recipient_country": null,
        "recipient_floor": null,
        "items": 1,
        "weight": "1.00",
        "is_saturday": false,
        "is_reception": false,
        "is_protocol": false,
        "is_return_doc": false,
        "is_package_return": 0,
        "is_cod": true,
        "cod_total": "90.70",
        "order_total": "90.70",
        "our_charge": true,
        "related_id": "123",
        "related_id_secondary": null,
        "notes": "Order id: 100010653",
        "voucher_number": "700000012345",
        "message": "Εγινε Παράδοση Στον Παραλήπτη",
        "is_risky": false,
        "sent_to_provider": true,
        "sms_enabled": true,
        "sms_sent": 1,
        "sms_sent_at": "2021-02-03T19:01:46.000000Z",
        "tracked_at": "2021-02-04 17:25:28",
        "created_at": "2021-02-03T12:08:57.000000Z",
        "agency": "acs_courier",
        "tracking_url": "https://www.acscourier.net/el/track-and-trace",
        "shipping_agency_id": "UUID",
        "platform_id": "UUID"
  }
}

3. Create a shipment

POST https://northapi.com/api/v2/shipment

Parameters:

Parameter Type Default Description
platform_id string Required The platform uuid found in panel
shipping_agency_id string Required The shipping agency uuid found in panel
pickup_date string today Pick up date in dd-mm-yyyy format (when available)
delivery_time string Specific delivery time (when available)
dispatcher_name string Dispatcher name for label (when available)
recipient_name string Required Recipient name
recipient_company string Recipient company
recipient_address_str string Required Recipient address street
recipient_address_num string Recipient address number
recipient_area string Required Recipient area
recipient_phone string Recipient Landine phone number
recipient_mobile string Required Recipient Mobile number (used for SMS, too)
recipient_zipcode string Required Recipient ZipCode
recipient_country string Recipient Country
recipient_floor string Recipient Floor
items integer Total packages
weight decimal Total weight
is_saturday boolean false Saturday delivery service (when available)
is_reception boolean false Keep to reception service (when available)
is_protocol boolean false Return protocol service (when available)
is_return_doc boolean false Return documents service (when available)
is_package_return boolean false Package return service (when available)
is_cod boolean false Shipment has COD
cod_total decimal Cash on delivery amount
order_total decimal Amount order total
our_charge boolean true Is company charged for the shipment
related_id string Main id for reference
related_id_secondary string Secondary id for reference
notes string Voucher notes
sms_enabled boolean false Sends sms to the customer

Response

{
  "success": true,
  "message": "",
  "data": {
        "uuid": "UUID",
        "pickup_date": "02-11-2020",
        "generated_at": null,
        "printed_at": null,
        "sent_at": null,
        "delivered_at": null,
        "paid_at": null,
        "returned_at": null,
        "cancelled_at": null,
        "delivery_time": null,
        "dispatcher_name": "Company",
        "recipient_name": "John Doe",
        "recipient_company": null,
        "recipient_address_str": "Vouliagmenis 32",
        "recipient_address_num": null,
        "recipient_area": "Attiki, Athens",
        "recipient_phone": null,
        "recipient_mobile": "6901234567",
        "recipient_zipcode": "12345",
        "recipient_country": null,
        "recipient_floor": null,
        "items": 1,
        "weight": "1.00",
        "is_saturday": false,
        "is_reception": false,
        "is_protocol": false,
        "is_return_doc": false,
        "is_package_return": 0,
        "is_cod": true,
        "cod_total": "90.70",
        "order_total": "90.70",
        "our_charge": true,
        "related_id": "123",
        "related_id_secondary": null,
        "notes": "Order id: 100010653",
        "voucher_number": null,
        "message": null,
        "is_risky": false,
        "sent_to_provider": null,
        "sms_enabled": true,
        "sms_sent": null,
        "sms_sent_at": null,
        "tracked_at":null,
        "created_at": "2021-02-03T12:08:57.000000Z",
        "agency": "acs_courier",
        "tracking_url": "https://www.acscourier.net/el/track-and-trace",
        "shipping_agency_id": "UUID",
        "platform_id": "UUID"
  }
}

4. Retrieve a shipment's tracking statuses

GET https://northapi.com/api/v2/shipment/UUID/tracking_status

Parameters:

information: a json object including courier full tracking response

Response

{
  "success": true,
  "message": "",
  "data": {
        "information": { ... },
        "message": "ΕΚΤΥΠΩΣΗ ΕΤΙΚΕΤΑΣ ACS CONNECT",
        "last_action_at": "2021-03-29T13:29:59.000000Z",
        "created_at": "2021-03-29T17:38:27.000000Z"
  }
}