Schema Reference API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://goldleaf.app/api/v1

Schemas

Warehouse

{
  "title": "Warehouse",
  "required": ["_id", "warehouseId", "name", "created", "lastModified", "deleted"],
  "properties": {
    "_id": {
      "type": "string"
    },
    "warehouseId": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "contact": {
      "type": "string"
    },
    "address1": {
      "type": "string"
    },
    "address2": {
      "type": "string"
    },
    "city": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "postalCode": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "erpId": {
      "type": "string"
    },
    "recordSource": {
      "type": "string"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "createdBy": {
      "type": "string"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time"
    },
    "lastModifiedBy": {
      "type": "string"
    },
    "deleted": {
      "type": "boolean"
    },
    "deletedDate": {
      "type": "string",
      "format": "date-time"
    },
    "deletedBy": {
      "type": "string"
    }
  }
}

Warehouse

Properties

Name	Type	Required	Restrictions	Description
_id	string	true	none	none
warehouseId	string	true	none	none
name	string	true	none	none
contact	string	false	none	none
address1	string	false	none	none
address2	string	false	none	none
city	string	false	none	none
country	string	false	none	none
phoneNumber	string	false	none	none
region	string	false	none	none
postalCode	string	false	none	none
code	string	false	none	none
erpId	string	false	none	none
recordSource	string	false	none	none
created	string(date-time)	true	none	none
createdBy	string	false	none	none
lastModified	string(date-time)	true	none	none
lastModifiedBy	string	false	none	none
deleted	boolean	true	none	none
deletedDate	string(date-time)	false	none	none
deletedBy	string	false	none	none