# Bowsala API

###### tags: `Bowsala`
All functionalities are accessible from a Bowsala API.

Authentications
---
Four header elements are mandatory for authentication purposes:

organisation-url: store.bowsala.sa
organisation-id: bowsala
user-id: From Login Response
access-token: From Login Response

## APIs List

### Login

You have to login first to have access token and user id.

**Headers**

organisation-url: store.bowsala.sa

**End Point**

https://app.shipsy.in/api/CustomerAnalytics/login

**Method**

POST

**Request**

{
    "username":"ABCD",
    "password":"1234"
}

**Response**

You won't need all the details from the response only the two required headers.

{
    "status": "OK",
    "data": {
        "access_token": {
            "id": "6JcDSKhcCmjIxKSjJarOLABb89UJUGs9sfOXun8KyoBrGFDAwWlJI06B8vWiZA6A",
            "expiry_at": "2021-06-01T17:22:22.609Z"
        },
        "Customer": {
            "id": "1047526251339714040",
        }
    }
}

---

### Add Shipment

To add a new shipment to your Bowsala account.

**End Point**

https://onlinebookingmultitenantbackend.shipsy.in/consignment/business/save

**Method**

POST

**Request**
> Please note that Pincode is only accepted with specific values.

{
  "customerReferenceNumber": ""
  "courierType": "NON-DOCUMENT",
  "consignmentType": "forward",
  "consignmentCategory": "domestic",
  "piecesDetail": {
    "weight": "",
    "length": "",
    "height": "",
    "width": ""
  },
  "allPiecesWithSameDimensions": true,
  "srcAddress": {
    "pincode": "",
    "name": "",
    "phone": "",
    "addressLine1":"",
    "cityName": "",
    "stateName": "",
    "isInternational": false
  },
  "dstAddress": {
    "pincode": "",
    "phone": "",
    "addressLine1": "",
    "cityName": "",
    "stateName": "",
    "isInternational": false
  },
  "numberOfPieces": "",
  "weight": 6,
  "dimensions": {
    "length": 50,
    "width": 50,
    "height": 50
  },
  "serviceType": "PREMIUM",
  "declaredPrice": "",
  "isRiskSurchargeApplicable": false,
  "isFragile": true,
  "commodityId": "7",
  "codCollectionMode": "",
  "codFavorOf": "",
  "codAmount": "",
  "description": "null",
  "ewayBill": {},
  "childClient": {
    "code": "",
    "id": "",
  }
}

**Response**

{
    "status":"OK",
    "data":{
        "referenceNumber":"XXXXXXXX"
    }
}

---

### Track Shipment
> Please note that here the headers are different from any other request

**Headers**

organisation-pretty-name: portal
organisation-url: portal.bowsala.sa

**End Point**

https://onlinebookingmultitenantbackend.shipsy.in/agent/consignment/getAgentPublicConsignments

**Method**

POST

**Request**

{
	"numbers": ["XXXXXXXX"],
	"searchMeta": {
	    "searchBy":"reference_number"
	}
}

**Response**

{
  "status": "OK",
  "data": [
    {
      "courierPartnerReferenceNumber": "Z2836908",
      "referenceNumber": "STR0270028",
      "courierPartnerId": null,
      "courierPartnerName": null,
      "status": "Delivered",
      "statusCode": "delivered",
      "customerReferenceNumber": null,
      "trackingHistory": [
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610538776587,
          "extra_details": {},
          "status_external": "delivered",
          "status_internal": "delivered",
          "event_description": "Delivered"
        },
        {
          "`": "forward",
          "location": null,
          "timestamp": 1610509922274,
          "extra_details": {},
          "status_external": "accept",
          "status_internal": "in_transit",
          "event_description": "In Transit"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610494063144,
          "extra_details": {},
          "status_external": "assigntoworker",
          "status_internal": "in_transit",
          "event_description": "In Transit"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610464191232,
          "extra_details": {},
          "status_external": "reachedathub",
          "status_internal": "in_transit",
          "event_description": "In Transit"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610402157111,
          "extra_details": {},
          "status_external": "outscan_at_hub",
          "status_internal": "in_transit",
          "event_description": "In Transit"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610402157111,
          "extra_details": {},
          "status_external": "intransittohub",
          "status_internal": "in_transit",
          "event_description": "In Transit"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610402108935,
          "extra_details": {},
          "status_external": "inscan_at_hub",
          "status_internal": "in_transit",
          "event_description": "In Transit"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610369102122,
          "extra_details": {},
          "status_external": "pickup_completed",
          "status_internal": "pickup_completed",
          "event_description": "Pickup Completed"
        },
        {
          "type": "forward",
          "location": null,
          "timestamp": 1610356452665,
          "extra_details": {},
          "status_external": "softdata_upload",
          "status_internal": "softdata_upload",
          "event_description": "Softdata Upload"
        }
      ]
    }
  ]
}

---

### Print Packages Label

**End Point**

https://onlinebookingmultitenantbackend.shipsy.in/print/getStream

**Method**

POST

**Request**

{
    "referenceNumbers":["XXXXXXX"],
    "isSmall":false
}

**Response**

It's a stream of data that will open a page and start printing labels.