Campaign Delivery

Campaign Delivery Service APIs

Facilitates the delivery of campaign resources to registered beneficiaries.

Create a Delivery.

post

Creates Delivery On successful Delivery Ok response is returned.

Body

The request object, containing all necessary information for creating an delivery and the request body metadata

Responses

200

Delivery Request created successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /delivery/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "delivery": {
    "clientReferenceId": "GUID",
    "tenantId": "tenantA",
    "campaignId": "ID-1",
    "registrationId": "R-ID-1",
    "warehouseId": "WARE-HOUSE-3",
    "resources": [
      {
        "resourceId": "ID-1",
        "quantityToBeDelivered": 100,
        "reasonIfNotDelivered": "text",
        "isDelivered": true,
        "quantityDelivered": "BALE"
      }
    ],
    "deliveredBy": "UUID",
    "deliveryDate": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "status": "DELIVERED"
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "delivery": {
    "clientReferenceId": "GUID",
    "tenantId": "tenantA",
    "campaignId": "ID-1",
    "registrationId": "R-ID-1",
    "warehouseId": "WARE-HOUSE-3",
    "resources": [
      {
        "resourceId": "ID-1",
        "quantityToBeDelivered": 100,
        "reasonIfNotDelivered": "text",
        "isDelivered": true,
        "quantityDelivered": "BALE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "deliveredBy": "UUID",
    "deliveryDate": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "DELIVERED",
    "deliveryId": "UUID"
  }
}

Update A Delivery.

post

Update Delivery, Ok response is returned.

Body

deliveryall ofOptional

Responses

200

Updated Delivery successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /delivery/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 607

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "delivery": {
    "clientReferenceId": "GUID",
    "tenantId": "tenantA",
    "campaignId": "ID-1",
    "registrationId": "R-ID-1",
    "warehouseId": "WARE-HOUSE-3",
    "resources": [
      {
        "resourceId": "ID-1",
        "quantityToBeDelivered": 100,
        "reasonIfNotDelivered": "text",
        "isDelivered": true,
        "quantityDelivered": "BALE"
      }
    ],
    "deliveredBy": "UUID",
    "deliveryDate": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "status": "DELIVERED",
    "deliveryId": "UUID"
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "delivery": {
    "clientReferenceId": "GUID",
    "tenantId": "tenantA",
    "campaignId": "ID-1",
    "registrationId": "R-ID-1",
    "warehouseId": "WARE-HOUSE-3",
    "resources": [
      {
        "resourceId": "ID-1",
        "quantityToBeDelivered": 100,
        "reasonIfNotDelivered": "text",
        "isDelivered": true,
        "quantityDelivered": "BALE",
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 1,
          "lastModifiedTime": 1
        }
      }
    ],
    "deliveredBy": "UUID",
    "deliveryDate": 1663218161,
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "status": "DELIVERED",
    "deliveryId": "UUID"
  }
}

Search Delivery.

post

Search Delivery Ok response is returned.

Body

Responses

200

Fetched Search Delivery.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /delivery/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "deliverySearchCriteria": {
    "campaignId": "UUID",
    "registrationId": "ID",
    "deliveryDate": 1663218161,
    "clientReferenceId": "GUID",
    "limit": 0,
    "offset": 0
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 0,
  "deliveries": [
    {
      "clientReferenceId": "GUID",
      "tenantId": "tenantA",
      "campaignId": "ID-1",
      "registrationId": "R-ID-1",
      "warehouseId": "WARE-HOUSE-3",
      "resources": [
        {
          "resourceId": "ID-1",
          "quantityToBeDelivered": 100,
          "reasonIfNotDelivered": "text",
          "isDelivered": true,
          "quantityDelivered": "BALE",
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          }
        }
      ],
      "deliveredBy": "UUID",
      "deliveryDate": 1663218161,
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "status": "DELIVERED",
      "deliveryId": "UUID"
    }
  ]
}