ShiftDocs

Reference

Examples

Creates a simple forward order with minimal required fields for quick order processing.

Use Case 1: Basic Forward Order

{
  "orderNumber": "ORD-001",
  "pickupLocation": {
    "name": "Sender Name",
    "address": {
      "addressLine1": "123 Sender St",
      "addressLine2": "Suite 100",
      "city": "SenderCity",
      "state": "SenderState",
      "pincode": 500001
    },
    "phone": "9000000001",
    "email": "sender@example.com"
  },
  "dropLocation": {
    "name": "Receiver Name",
    "address": {
      "addressLine1": "456 Receiver Ave",
      "addressLine2": "Apt 202",
      "city": "ReceiverCity",
      "state": "ReceiverState",
      "pincode": 500002
    },
    "phone": "9000000002",
    "email": "receiver@example.com"
  },
  "shipments": {
    "weightInGrams": 1500
  }
}

Use Case 2: Prepaid Order with Product Details

Creates a comprehensive prepaid order with detailed product information, ideal for e-commerce shipments.

{
  "orderNumber": "ORD-002-PPD",
  "pickupLocation": {
    "name": "Electronics Store",
    "address": {
      "addressLine1": "789 Tech Park",
      "addressLine2": "Building A, Floor 3",
      "city": "Hyderabad",
      "state": "Telangana",
      "pincode": 500081
    },
    "phone": "9876543210",
    "email": "store@techpark.com"
  },
  "dropLocation": {
    "name": "John Doe",
    "address": {
      "addressLine1": "101 Customer Street",
      "addressLine2": "Apartment 505",
      "city": "Bangalore",
      "state": "Karnataka",
      "pincode": 560001
    },
    "phone": "9123456789",
    "email": "john@example.com"
  },
  "shipments": {
    "weightInGrams": 2500,
    "product_details": [
      {
        "quantity": 2,
        "description": "Wireless Headphones - Black",
        "hsn_code/sku_code": "WHB-001",
        "category_of_goods": "Electronics",
        "commodity_value": 2999.99,
        "weight_grams": 500,
        "height_cm": 20,
        "length_cm": 15,
        "breadth_cm": 10
      }
    ],
    "payment_details": {
      "payment_mode": "PPD",
      "amount": 6499.97
    },
    "dimensions": {
      "length_cm": 25,
      "breadth_cm": 20,
      "height_cm": 15
    }
  }
}

Use Case 3: Cash on Delivery (COD) Order

Creates a COD order where payment is collected upon delivery, common for fashion and retail items.

{
  "orderNumber": "ORD-003-COD",
  "pickupLocation": {
    "name": "Fashion Boutique",
    "address": {
      "addressLine1": "Mall Road",
      "addressLine2": "Shop No. 45",
      "city": "Mumbai",
      "state": "Maharashtra",
      "pincode": 400001
    },
    "phone": "9988776655",
    "email": "fashion@boutique.com"
  },
  "dropLocation": {
    "name": "Sarah Johnson",
    "address": {
      "addressLine1": "Green Valley Apartments",
      "addressLine2": "Flat 302, Tower B",
      "city": "Pune",
      "state": "Maharashtra",
      "pincode": 411001
    },
    "phone": "9876543210",
    "email": "sarah@example.com"
  },
  "shipments": {
    "weightInGrams": 800,
    "product_details": [
      {
        "quantity": 1,
        "description": "Designer Dress - Red",
        "hsn_code/sku_code": "DD-RED-L",
        "category_of_goods": "Apparel",
        "commodity_value": 3500,
        "weight_grams": 400,
        "height_cm": 5,
        "length_cm": 40,
        "breadth_cm": 30
      }
    ],
    "payment_details": {
      "payment_mode": "COD",
      "amount": 4500,
      "codCollectibleAmount": 4500
    },
    "dimensions": {
      "length_cm": 45,
      "breadth_cm": 35,
      "height_cm": 10
    }
  }
}

Use Case 4: Using Existing Address UIDs

Efficiently creates orders using pre-registered address UIDs, reducing data redundancy and processing time.

{
  "orderNumber": "ORD-004-EXISTING",
  "pickupLocation": {
    "addressUid": 59673
  },
  "dropLocation": {
    "addressUid": 59674
  },
  "shipments": {
    "weightInGrams": 1200,
    "product_details": [
      {
        "quantity": 1,
        "description": "Book - Programming Guide",
        "hsn_code/sku_code": "BK-PG-001",
        "category_of_goods": "Books",
        "commodity_value": 599,
        "weight_grams": 1200,
        "height_cm": 3,
        "length_cm": 24,
        "breadth_cm": 18
      }
    ],
    "payment_details": {
      "payment_mode": "PPD",
      "amount": 599
    },
    "dimensions": {
      "length_cm": 24,
      "breadth_cm": 18,
      "height_cm": 3
    }
  }
}

Use Case 5: Mixed Address Order

Combines existing pickup address UID with new drop location details for flexible order processing.

{
  "orderNumber": "ORD-005-MIXED",
  "pickupLocation": {
    "addressUid": 59673
  },
  "dropLocation": {
    "name": "New Customer",
    "address": {
      "addressLine1": "789 New Street",
      "addressLine2": "Building C",
      "city": "Delhi",
      "state": "Delhi",
      "pincode": 110001
    },
    "phone": "9876543210",
    "email": "newcustomer@example.com"
  },
  "shipments": {
    "weightInGrams": 750,
    "product_details": [
      {
        "quantity": 3,
        "description": "T-Shirt - Cotton",
        "hsn_code/sku_code": "TS-CTN-M",
        "category_of_goods": "Apparel",
        "commodity_value": 399,
        "weight_grams": 250,
        "height_cm": 2,
        "length_cm": 30,
        "breadth_cm": 25
      }
    ],
    "payment_details": {
      "payment_mode": "COD",
      "amount": 1197,
      "codCollectibleAmount": 1197
    },
    "dimensions": {
      "length_cm": 30,
      "breadth_cm": 25,
      "height_cm": 6
    }
  }
}

Stuck on an integration?

Your account manager can put you in touch with our tech team.

Talk to us