Stryde Platform logo
API docs by Redocly

Stryde API Documentation (1.0.0)

Download OpenAPI specification:Download

Introduction

Welcome to the Stryde Platform API documentation. This API provides programmatic access to Stryde's order management, item catalog, and delivery tracking functionalities.

Key Features

  • Create & retrieve Sales Orders
  • Access Item Master Data
  • Create Deliveries against Sales Orders

This documentation aims to provide all the information you need to work with our API. We hope you find it helpful and easy to use. If you have any questions or need further assistance, please don't hesitate to contact our developer support team.

Getting Started

To start using the Stryde API:

  1. Request Access to the API from the Stryde IT team with the appropriate permissions.
  2. Start making API requests to manage orders, items, and deliveries using the following endpoint http://portal.stryde.com.kw/api

For detailed instructions on authentication and example API calls, please refer to the relevant sections in this documentation.

Access Token

Generate API Access Token

Generate Access Token

This endpoint generates an access token for the user.

Authorizations:
bearer_token
header Parameters
Accept
required
string
Default: application/json

The format of the response.

Request Body schema: application/json
required
username
required
any

Username to authenticate with.

password
required
string

Password to authenticate with.

Responses

Request samples

Content type
application/json
{
  • "username": "admin",
  • "password": 12345678
}

Response samples

Content type
application/json
{
  • "bearer_token": "A5syvgQg0RkJwb4s1oWFUWQig5q3JNXF63f905c0"
}

Orders

Create & retrieve sales orders.

Get all Orders

This operation retrieves all orders from the system. You can filter the orders by company.

Authorizations:
bearer_token
query Parameters
company
string
Example: company=SC00001

The company for which you want to retrieve the data.

header Parameters
Accept
required
string
Default: application/json

The format of the response.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create New Order

This operation creates a new order in the system based on the information provided

Authorizations:
bearer_token
header Parameters
Accept
required
string
Default: application/json

The format of the response.

Request Body schema: application/json
required
company
string

The company code associated with the order.

clientRefCode
string

Order Number in Client System.

clientRefNum
string

Extra Reference Number Provided by the client.

documentDate
string <date>

The date when the order was created.

deliveryDate
string <date>

The date when the order to be delivered.

homeDelivery
boolean

Indicates if the order is for Home Delivery or Bulk. 1 for Home Delivery, 0 for Bulk.

remarks
string

Additional remarks about the order.

object

Details of the customer who placed the order.

object

Details of the address where the order is to be delivered.

Array of objects (OrderItem)

List of items in the order.

Responses

Request samples

Content type
application/json
{
  • "company": "SC00001",
  • "clientRefCode": "101149532",
  • "clientRefNum": "2038673464",
  • "documentDate": "2024-08-14",
  • "deliveryDate": "2024-08-15",
  • "homeDelivery": 1,
  • "remarks": "Please deliver the order before 12:00 PM.",
  • "customerDetails": {
    },
  • "addressDetails": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Sales Order Created",
  • "company": "SC00001",
  • "orderCode": "SO0000001",
  • "clientRefCode": 101149532
}

Get Specific Order Details By Code

This operation retrieves a specific order details from the system.

Authorizations:
bearer_token
path Parameters
code
required
string
Example: SO0000001

Order Code in the System

header Parameters
Accept
required
string
Default: application/json

The format of the response.

Responses

Response samples

Content type
application/json
{
  • "company": "SC00001",
  • "companyName": "Al Andalus Trading Company",
  • "code": "SO0000001",
  • "clientRefCode": "101149532",
  • "clientRefNum": "2038673464",
  • "documentDate": "2024-08-14",
  • "deliveryDate": "2024-08-15",
  • "status": "Open",
  • "deliveryType": "Express - Home (1 day)",
  • "remarks": "Please deliver the order before 12:00 PM.",
  • "customerDetails": {
    },
  • "addressDetails": {
    },
  • "items": [
    ]
}

Items

Retrieve Item Master Data & Inventory. Items are gradually added to the system based on the orders the system receives.

Get all Items

This operation retrieves all items from the system. You can filter the items by Item Code, Company and timestamp.

You can utilize the timestamp parameter to fetch items updated after a certain DateTime, that way you will be able to get the latest items added or updated to the system.

Authorizations:
bearer_token
query Parameters
company
string
Example: company=SC00001

The company for which you want to retrieve the data.

item_code
string
Example: item_code=HHP002556

The item code for which you want to retrieve the data.

timestamp
string <datetime>
Example: timestamp=2024-07-07 20:01:00

The timestamp to fetch items updated after this timestamp.

header Parameters
Accept
required
string
Default: application/json

The format of the response.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Specific Item Details By Code

This operation retrieves an item from the system specified by the Item Code.

Authorizations:
bearer_token
path Parameters
code
required
string
Example: HHP002556

The item code for which you want to retrieve the data.

header Parameters
Accept
required
string
Default: application/json

The format of the response.

Responses

Response samples

Content type
application/json
{
  • "company": "SC00001",
  • "itemCode": "HHP002554",
  • "description": "Samsung Galaxy Z Flip 5 256GB Graphite",
  • "foreignDescription": "فليب 5 256 جيجا جرافيت",
  • "modelCode": "SM-F731BZA1MEA",
  • "barcode": 8806095180717,
  • "manufacturer": "Samsung Mobile",
  • "itemGroup": "HHP",
  • "managedBy": "Serial Number",
  • "updatedAt": "2024-07-06 12:57:52",
  • "quantity": 1,
  • "itemMeasurement": {
    },
  • "itemInventory": [
    ],
  • "serialNumbers": [
    ],
  • "batchNumbers": [
    ]
}

Import Items from SAP (For Testing Purpose)

This endpoint is used to import items into the portal from SAP for testing purposes.

Authorizations:
bearer_token
header Parameters
Accept
required
string
Default: application/json

The format of the response.

Request Body schema: application/json
required
Array
company
required
any

The company code associated with the order.

itemCode
required
string

Item Code to identify the item.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deliveries

Create & retrieve deliveries against sales orders.

Get all Deliveries

This operation retrieves all Deliveries from the system. You can filter the orders by company.

Authorizations:
bearer_token
query Parameters
company
string
Example: company=SC00001

The company for which you want to retrieve the data.

header Parameters
Accept
required
string
Default: application/json

The format of the response.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create New Delivery Against a Specific Order

This operation creates a new order in the system based on the information provided

Authorizations:
bearer_token
header Parameters
Accept
required
string
Default: application/json

The format of the response.

Request Body schema: application/json
required
One of
company
required
any

The company code associated with the order.

orderCode
required
string

The unique code associated with the order.

docNum
string

The document number associated with the order, used when orderCode is not provided.

deliveryDate
required
string <date>

The date when the order was delivered.

remarks
string

Additional remarks about the order.

required
Array of objects (DeliveryItem)

List of items in the order.

Responses

Request samples

Content type
application/json
{
  • "company": "SC00001",
  • "orderCode": "101144569",
  • "docNum": "58",
  • "deliveryDate": "2024-08-15",
  • "remarks": "Please deliver the order before 12:00 PM.",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Delivery Created",
  • "code": "DO0000002"
}

Get Specific Delivery Details By Code

This operation retrieves a specific delivery details from the system.

Authorizations:
bearer_token
path Parameters
code
required
string
Example: DO0000023

Delivery Code in the System

header Parameters
Accept
required
string
Default: application/json

The format of the response.

Responses

Response samples

Content type
application/json
{
  • "company": "SC00001",
  • "companyName": "Al Andalus Trading Company",
  • "code": "DO0000001",
  • "salesOrderCode": "SO0000002",
  • "date": "2024-08-14",
  • "remarks": "Delivery Delayed till 3:00 PM.",
  • "customerDetails": {
    },
  • "addressDetails": {
    },
  • "items": [
    ]
}