Update Supplier Master Data

Last Updated 24/10/2022

Shipper API gives interface access to our clients for updating Supplier Master Data API from their own system to Shipper Warehouse Management System

Specification

MethodEndpoint
PUT /v3/fulfillment/supplier

Body Request Parameter

📘

Notes

"Please Fill with Empty String / 0 / false" note means client still need to pass ““ / 0 / false value to that parameter.

Field

Data Type

Description

Note

id

string

Supplier Master id got from here

Example: SUP003

Mandatory

supplier_id

string(10)

id for supplier identification

Example: tessup_1

Optional

maximal character length: 10

system will convert to all uppercase if user not defined, system will auto generate

type

string(2)

Set the value to “VE” (Supplier)

notes: just fill value for this field with **VE**

Mandatory

supplier_descr_1

string(100)

Supplier Short Name

Example: Supplier Food

Mandatory

address_1

string(200)

Supplier Address 1

Mandatory

country

string(2)

Supplier Country code Location

Example: ID

Mandatory

contact_1

string(200)

Supplier Contact Name

Mandatory

contact_1_title

string(20)

Supplier Contact Title

Example: Warehouse Manager

Mandatory

contact_1_email

string(100)

Supplier Contact Email Address

Mandatory

contact_1_tel_1

string(15)

Supplier Contact Phone

Mandatory

contact_1_tel_2

string(50)

Supplier Contact Phone 2

Optional

contact_1_fax

string(50)

Contact Fax

Optional

easy_code

string(500)

Supplier Mnemonic Code that indices supplier name

Example: SUPFO

Optional

supplier_descr_2

string(200)

Supplier Long Name

Example: Supplier FF

Optional

address_2

string(200)

Supplier Address 2

Optional

province

string(20)

Supplier Province Location

Optional

city

string(50)

Supplier City Location

Optional

district

string(50)

Supplier District Location

Optional

street

string(50)

Supplier Street Name

Optional

route_code

string(10)

Code identify location of supplier

Optional

zip_code

string(5)

Supplier Zip Code location

Optional

stop_station

string(10)

Stop station of supplier location

Optional

bank_account

string(50)

Bank Account Information

Example: BCA 12345678901112

Optional

currency

string(3)

Currency Used by Supplier

Example : IDR

Optional

user_define_1

string(200)

Defined by Shipper

Please Fill with Empty String

user_define_2

string(200)

Defined by Shipper

Please Fill with Empty String

notes

text(200)

More note about the supplier

Example: this is supplier for all food in jakarta

Optional

Sample Body Request

{
  "data": {
    "suppliers": [
      {
        "address_1": "Jalan Gambir",
        "address_2": "Jalan Thamrin",
        "city": "Jakarta Pusat",
        "contact_1": "contact 1",
        "contact_1_email": "[email protected]",
        "contact_1_fax": "021-6789012",
        "contact_1_tel_1": "021-123456",
        "contact_1_tel_2": "021-345567",
        "contact_1_title": "Sales Dept Head",
        "country": "ID",
        "currency": "IDR",
        "district": "Gambir",
        "easy_code": "SPFOOD",
        "notes": "This is supplierfood notes",
        "province": "DKI Jakarta",
        "route_code": "BJ",
        "street": "Gambir",
        "stop_station":"stop",
        "supplier_descr_1": "Supplierfood description 1",
        "supplier_descr_2": "Supplierfood description 2",
        "supplier_id": "SUPPLIER_1",
        "type": "VE",
        "user_define_1": "",
        "user_define_2": "",
        "zip_code": "41235"
      }
    ]
  }
}
{
  "data": {
    "suppliers": [
      {
        "address_1": "Jalan Gambir",
        "contact_1": "contact 1",
        "contact_1_email": "[email protected]",
        "contact_1_tel_1": "021-123456",
        "contact_1_title": "Sales Dept Head",
        "country": "ID",
        "supplier_descr_1": "Supplierfood description 1",
        "supplier_id": "SUPPLIER_1",
        "type": "VE"
      }
    ]
  }
}

Sample Response

{
  "metadata": {
    "path": "/v3/fulfillment/supplier",
    "http_status_code": 201,
    "http_status": "Created",
    "timestamp": 1616119205
  },
  "data": {
    "request_id": "supplier.2021.06.09153531.853760"
  }
}
{
  "metadata": {
    "path": "/v3/fulfillment/supplier",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1637566020
  }
}
{
  "metadata": {
    "path": "/v3/fulfillment/supplier",
    "http_status_code": 401,
    "http_status": "Unauthorized",
    "errors": [
      {
        "code": 10001,
        "message": "Unauthorized Access. You are not authorized to access this resource."
      }
    ],
    "timestamp": 1637566072
  }
}
{
	"metadata": {
    "path": "/v3/fulfillment/supplier",
    "http_status_code": 500,
    "http_status": "Internal Server Error",
    "errors": [
      {
        "code": 803,
        "message": "Internal Server error."
      }
    ],
    "timestamp": 1637555484
  }
}