How To: Platform Order Management

8min
How to: Config Platform Order Attributes
For information about prerequisites, see Creating Order﻿. Call the Order Config﻿ endpoint to add the Attributes to a Platform Order.The following sample request body only defines a couple of custom Attributes such as the name of Order attributes for an Order.
JSON
{
  "attributes": [
    {
      "name": "Order1",
      "description": "creating order attribute",
      "indexed": true,
      "dataType": "string",
      "validation": {
        "range": {
          "min": 0,
          "max": 5
        },
        "regex": "string",
        "valueOneOf": [
          "string123",
          "string124"
        ],
        "required": false
      }
    },
    {
      "name": "Order2",
      "description": "initiating",
      "indexed": true,
      "dataType": "number",
      "defaultValue": 1,
      "validation": {
        "range": {
          "min": 0,
          "max": 5
        },
        "valueOneOf": [
          0,1,2,3,4,5
        ],
        "required": true
      }
    }
  ]
}

{
  "attributes": [
    {
      "name": "Order1",
      "description": "creating order attribute",
      "indexed": true,
      "dataType": "string",
      "validation": {
        "range": {
          "min": 0,
          "max": 5
        },
        "regex": "string",
        "valueOneOf": [
          "string123",
          "string124"
        ],
        "required": false
      }
    },
    {
      "name": "Order2",
      "description": "initiating",
      "indexed": true,
      "dataType": "number",
      "defaultValue": 1,
      "validation": {
        "range": {
          "min": 0,
          "max": 5
        },
        "valueOneOf": [
          0,1,2,3,4,5
        ],
        "required": true
      }
    }
  ]
}
﻿
How to Update Configured Order Attributes
To update the configured Order attributes, call the Update Order Attributes ﻿endpoint.
How to Get Configuration of Order Attributes
To get the list of all configured Order attributes, call the Get Custom Attributes of an Order﻿ endpoint.
How to: Configure Order State Machine
Learn more about the State Machine﻿ Service. Learn more about configuring State Machine﻿.
How to Get Order State Machine Configuration
To get the configuration of a State Machine for an Order call the Get Order State Machine Configuration﻿ endpoint.
How to Update Order State Machine Configuration
Call the Update State Machine Configuration﻿﻿ for an Order endpoint to update the State Machine configuration.
How to: Create an Order
Before creating an Order, configure Platform Order Attributes﻿. Once the attributes are configured call Create Order endpoint and pass the payload similar to what is shown below.
JSON
{
    "shipmentFlow": "CONSIGNMENT",
    "workOrderFlowType": "SEQUENTIAL",
    "dropDetails": {
        "contact": {
            "name": "order",
            "phone": {
                "countryCode": "+1",
                "number": "+15559876543",
                "isMobile": true
            }
        },
        "location": {
            "address": {
                "addressLine1": "123 Main Street Anytown",
                "city": "Queen",
                "country": {
                    "code": "USA",
                    "name": "United States"
                }
            }
        }
    },
    "clientDetails": {
        "clientName": "John Doe",
        "clientId": "tenants:cfecb885-e060-514a-b4f7-0094cf6148e2",
        "clientOrderId": "order:bd5f3a6c-761d-4bd1-aa69315d3850"
    },
    "orderSummary": {
        "invoiceNumber": "H_Xv:9OhhCety_ZR1WRnMmIGeGHT5HWM14cJwDx70_41pIYW0vclc3xvGWbwq29O",
        "orderDescription": "Sample description for the order",
        "totalWeight": {
            "value": 0,
            "unit": "kg"
        },
        "totalItems": 0,
        "totalOrderCost": {
            "cost": 100,
            "currencyCode": "LKR",
            "minorUnit": 2
        }
    },
    "workOrders": [
        {
            "serviceTemplateId": "template:ed63ac89-f13e-4f49-8714-98648",
            "serviceTemplateName": "expressservice",
            "pickupDetails": {
                "contact": {
                    "name": "Jane Doe",
                    "phone": {
                        "countryCode": "+1",
                        "number": "5559876543",
                        "isMobile": true
                    }
                },
                "location": {
                    "address": {
                        "addressLine1": "456 Oak Avenue Springfield",
                        "city": "Queen",
                        "country": {
                            "code": "USA",
                            "name": "United States"
                        }
                    }
                },
                "pickUpSlot": {
                    "from": 21216521,
                    "to": 276216712
                },
                "serviceTime": 1
            },
            "returnDetails": {
                "contact": {
                    "name": "John Doe",
                    "phone": {
                        "countryCode": "+1",
                        "number": "5559876543",
                        "isMobile": true
                    }
                },
                "location": {
                    "address": {
                        "addressLine1": "123 Main Street Anytown",
                        "city": "Queens",
                        "country": {
                            "code": "USA",
                            "name": "United States"
                        }
                    }
                },
                "returnSlot": {
                    "from": 162733,
                    "to": 2162172
                },
                "serviceTime": 1
            },
            "attributes": {
                "productType": "PARCEL",
                "mile": "singleleg",
                "speedOfTransport": "EXPRESS",
                "modeOfTransport": "SURFACE",
                "shipmentFlow": "REVERSE",
                "paymentType": "cod",
                "teamId": "Team01"
            },
            "containers": [
                {
                    "containerType": "orderfpasts",
                    "scannableId": "scan:id:bd5f3a6c-761d-4bd2-a6912",
                    "trackingDetails": {
                        "operator": "DELHI",
                        "trackingId": "Delhi:01",
                        "isPrimary": true
                    },
                    "attributes": {
                        "dimensions": {
                            "length": "10",
                            "breadth": "10",
                            "height": "10",
                            "unit": "m"
                        },
                        "weight": {
                            "value": "10",
                            "unit": "kg"
                        },
                        "shipmentDetails": [
                            {
                                "name": "bag",
                                "code": "bag",
                                "quantity": 1,
                                "totalCost": {
                                    "cost": 0,
                                    "currencyCode": "LKR",
                                    "minorUnit": 0
                                }
                            }
                        ]
                    }
                }
            ],
            "type": "MOVE_CONTAINER"
        }
    ]
}
{
    "shipmentFlow": "CONSIGNMENT",
    "workOrderFlowType": "SEQUENTIAL",
    "dropDetails": {
        "contact": {
            "name": "order",
            "phone": {
                "countryCode": "+1",
                "number": "+15559876543",
                "isMobile": true
            }
        },
        "location": {
            "address": {
                "addressLine1": "123 Main Street Anytown",
                "city": "Queen",
                "country": {
                    "code": "USA",
                    "name": "United States"
                }
            }
        }
    },
    "clientDetails": {
        "clientName": "John Doe",
        "clientId": "tenants:cfecb885-e060-514a-b4f7-0094cf6148e2",
        "clientOrderId": "order:bd5f3a6c-761d-4bd1-aa69315d3850"
    },
    "orderSummary": {
        "invoiceNumber": "H_Xv:9OhhCety_ZR1WRnMmIGeGHT5HWM14cJwDx70_41pIYW0vclc3xvGWbwq29O",
        "orderDescription": "Sample description for the order",
        "totalWeight": {
            "value": 0,
            "unit": "kg"
        },
        "totalItems": 0,
        "totalOrderCost": {
            "cost": 100,
            "currencyCode": "LKR",
            "minorUnit": 2
        }
    },
    "workOrders": [
        {
            "serviceTemplateId": "template:ed63ac89-f13e-4f49-8714-98648",
            "serviceTemplateName": "expressservice",
            "pickupDetails": {
                "contact": {
                    "name": "Jane Doe",
                    "phone": {
                        "countryCode": "+1",
                        "number": "5559876543",
                        "isMobile": true
                    }
                },
                "location": {
                    "address": {
                        "addressLine1": "456 Oak Avenue Springfield",
                        "city": "Queen",
                        "country": {
                            "code": "USA",
                            "name": "United States"
                        }
                    }
                },
                "pickUpSlot": {
                    "from": 21216521,
                    "to": 276216712
                },
                "serviceTime": 1
            },
            "returnDetails": {
                "contact": {
                    "name": "John Doe",
                    "phone": {
                        "countryCode": "+1",
                        "number": "5559876543",
                        "isMobile": true
                    }
                },
                "location": {
                    "address": {
                        "addressLine1": "123 Main Street Anytown",
                        "city": "Queens",
                        "country": {
                            "code": "USA",
                            "name": "United States"
                        }
                    }
                },
                "returnSlot": {
                    "from": 162733,
                    "to": 2162172
                },
                "serviceTime": 1
            },
            "attributes": {
                "productType": "PARCEL",
                "mile": "singleleg",
                "speedOfTransport": "EXPRESS",
                "modeOfTransport": "SURFACE",
                "shipmentFlow": "REVERSE",
                "paymentType": "cod",
                "teamId": "Team01"
            },
            "containers": [
                {
                    "containerType": "orderfpasts",
                    "scannableId": "scan:id:bd5f3a6c-761d-4bd2-a6912",
                    "trackingDetails": {
                        "operator": "DELHI",
                        "trackingId": "Delhi:01",
                        "isPrimary": true
                    },
                    "attributes": {
                        "dimensions": {
                            "length": "10",
                            "breadth": "10",
                            "height": "10",
                            "unit": "m"
                        },
                        "weight": {
                            "value": "10",
                            "unit": "kg"
                        },
                        "shipmentDetails": [
                            {
                                "name": "bag",
                                "code": "bag",
                                "quantity": 1,
                                "totalCost": {
                                    "cost": 0,
                                    "currencyCode": "LKR",
                                    "minorUnit": 0
                                }
                            }
                        ]
                    }
                }
            ],
            "type": "MOVE_CONTAINER"
        }
    ]
}
﻿
Managing Orders
To manage an order, utilize the endpoints provided by the Order service﻿. Call the Update Order attributes endpoint for modifications in Order created, while the Get Order details endpoint helps retrieve in-depth details about the orders. Apply the Order Cancellation endpoint for changes in cancellation details and to add or update the WorkOrder, use the Add WorkOrder to the Order endpoint.
Add WorkOrder to the Order
[
    {
        "amountToCollectOnDelivery": {
            "currencyCode": "INR",
            "amount": 1000
        },
        "pickupQualityChecks": {},
        "collectAmountOnPickup": true,
        "description": "Sample first workorder",
        "type": "MOVE_CONTAINERS",
        "pickupAddress": "location:653163f0-cb49-4451-aecb-491303c56ea4",
        "attributes": {
            "stringValidations": "string111",
            "intValidations": 1
        },
        "containers": [
            "container:001",
            "container:002"
        ]
    }
]

[
    {
        "amountToCollectOnDelivery": {
            "currencyCode": "INR",
            "amount": 1000
        },
        "pickupQualityChecks": {},
        "collectAmountOnPickup": true,
        "description": "Sample first workorder",
        "type": "MOVE_CONTAINERS",
        "pickupAddress": "location:653163f0-cb49-4451-aecb-491303c56ea4",
        "attributes": {
            "stringValidations": "string111",
            "intValidations": 1
        },
        "containers": [
            "container:001",
            "container:002"
        ]
    }
]
﻿
How to: Configure Custom Code in Platform Order Management
Learn more about Custom Code﻿.
To register Custom Code configuration in the Platform Order Management service call register custom code configurations﻿ API Endpoint.
Sample payload for adding Custom code configuration is given below:
JSON
{
    "url": "https://mocki.io/v1/54eaffb4-9a3b-4043-807a-e1f6586773hd",
    "requestHeader": {
        "header2": "Header2"
    },
    "method": "GET",
    "wait": true,
    "acceptableStatusCodes": [
        200,
        404
    ],
    "raiseErrorOnStatusMismatch": true,
    "methodName": "updateOrder:onRequest",
    "enabled": true
}
{
    "url": "https://mocki.io/v1/54eaffb4-9a3b-4043-807a-e1f6586773hd",
    "requestHeader": {
        "header2": "Header2"
    },
    "method": "GET",
    "wait": true,
    "acceptableStatusCodes": [
        200,
        404
    ],
    "raiseErrorOnStatusMismatch": true,
    "methodName": "updateOrder:onRequest",
    "enabled": true
}
﻿
How to: Update Custom Code Configuration
To update the Custom Code configuration in Platform Order Management, call the update custom code configurations﻿ endpoint.
How to: Get Configured Custom Code
To get the details of configured Custom Code in Platform Order Management, call the GET Custom Code Configuration﻿ endpoint.
Updated 16 Aug 2023
Did this page help you?
Integrate with Platform Order Management
How to: WorkOrder