Custom Schema - Outbound

Read the records GAINS holds for a custom schema with GET /custom/{ApiRoute}. What GAINS sets up for a schema is described in Custom Schema.

Read records back

GET /custom/{ApiRoute} returns the records GAINS holds for the schema, so a load appears only once its task is Completed. Results are paged with Size and Cursor, as described in Pagination.

GET /api/v1/custom/warehouse-zones?Size=2 HTTP/1.1
Host: acme.gainsystems.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJqTl9F...

{
  "Data": [
    {
      "Data": {
        "ZoneCode": "CHI01-A3",
        "LocationCode": "CHI01",
        "Capacity": 1250.5,
        "Refrigerated": true,
        "Notes": "Cold storage aisle, north wall"
      }
    },
    {
      "Data": {
        "ZoneCode": "CHI01-B1",
        "LocationCode": "CHI01",
        "Capacity": 800,
        "Refrigerated": false,
        "Notes": "Bulk pallets"
      }
    }
  ],
  "Paging": {
    "NextCursor": "eyJpZENvZGUiOiIxMDIifQ==",
    "CurrentDataCount": 2
  }
}

Records come back under the same attribute names you load them with, each inside its own Data object. Values come back in the type GAINS stores them in, so a numeric attribute you sent as "1250.5" can be returned as the number 1250.5.

Read records back

Related guides