GET List Supplier Master Data

Shipper API gives interface access to our clients for retrieving or pulling Supplier Master Data API from Shipper Warehouse Management System

Specification

Field	Endpoint
GET	/v3/fulfillment/suppliers

Query Parameter

Field	Data Type	Description	Mandatory Flag
created_start	yyyy-MM-dd	Start Date for searching Supplier master by creation date Example: 2021-11-01	Optional
created_end	yyyy-MM-dd	End Date for searching Supplier master by creation date Example: 2021-11-02	Optional
updated_start	yyyy-MM-dd	Start Date for searching Supplier master by updated date Example: 2021-11-01	Optional
updated_end	yyyy-MM-dd	Start Date for searching Supplier master by updated date Example: 2021-11-01	Optional
active_flag	Boolean	Activeness Flag of supplier master Example: true	Optional Choice of: true or false
Page	Integer	Page Number of searching Example: 1	Optional
Limit	Integer	Limit data Items per Page Example: 10	Optional

Sample Query Parameter

Header	How to Fill
X-Api-Key	Shipper Api Key

/v3/fulfillment/suppliers?created_start=2021-11-10&created_end=2021-11-22&active_flag=true

created_start="2021-04-20"
created_end="2021-04-20"
updated_start="2021-04-20"
updated_end="2021-04-20"
page=1
limit=1
active_flag=true

Sample Body Response

{
  "metadata": {
    "path": "/v3/fulfillment/suppliers?created_start=2021-11-10&created_end=2021-11-22&active_flag=true",
    "http_status_code": 200,
    "http_status": "OK",
    "timestamp": 1637565593
  },
  "data": {
    "suppliers": [
      {
        "supplier_id": "ETXLACZZCH",
        "type": "",
        "supplier_descr_1": "valid",
        "supplier_descr_2": "",
        "easy_code": "",
        "active_flag": true,
        "ref_warehouse_id": ""
      },
      {
        "supplier_id": "HYYGQDTXDT",
        "type": "",
        "supplier_descr_1": "valid",
        "supplier_descr_2": "",
        "easy_code": "",
        "active_flag": true,
        "ref_warehouse_id": ""
      }
    ]
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/suppliers?created_start=12312&active_flag=false",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 800,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1637569174
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/suppliers?active_flag=false",
    "http_status_code": 401,
    "http_status": "Unauthorized",
    "errors": [
      {
        "code": 10001,
        "message": "Unauthorized Access. You are not authorized to access this resource."
      }
    ],
    "timestamp": 1637569096
  }
}

{
  "metadata": {
    "path": "/v3/fulfillment/suppliers?active_flag=false",
    "http_status_code": 404,
    "http_status": "Not Found",
    "errors": [
      {
        "code": 10004,
        "message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
      }
    ],
    "timestamp": 1637569142
  }
}