Jump to

• Request
• Response

Get all valid supplier commodity code

get

/service/v1/scommodity

This endpoints will be used to Get all valid supplier commodity code maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStatus(optional): string
• commodityCode(optional): string
• commodityName(optional): string
• supplierId: string

Header Parameters

• appId: string
• branchCode: string
  branchCode
• userId: string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : ObscfcmTmSupplierCommodityCodeSerCollection

Type: object

Show Source

• data(optional): array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObscfcmTmSupplierCommodityMasterDTO"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ObscfcmTmSupplierCommodityMasterDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObscfcmTmSupplierCommodityMasterDTO"
    }
}

Nested Schema : ObscfcmTmSupplierCommodityMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ObscfcmTmSupplierCommodityMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":""
                },
                "action":{
                    "type":"string",
                    "description":""
                },
                "autoAuth":{
                    "type":"string",
                    "description":""
                },
                "modificationStatus":{
                    "type":"string",
                    "description":""
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":""
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":""
                },
                "makerRemarks":{
                    "type":"string",
                    "description":""
                },
                "supplierId":{
                    "type":"string",
                    "description":""
                },
                "supplierName":{
                    "type":"string",
                    "description":""
                },
                "ObscfcmTmSupplierCommodityDetailsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ObscfcmTmSupplierCommodityDetailsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ObscfcmTmSupplierCommodityMasterDTO-allOf[1]

Type: object

Show Source

• action(optional): string
• autoAuth(optional): string
• checkerRemarks(optional): string
• datasegmentCode(optional): string
• id(optional): string
• makerRemarks(optional): string
• modificationStatus(optional): string
• ObscfcmTmSupplierCommodityDetailsDTO(optional): array ObscfcmTmSupplierCommodityDetailsDTO
• supplierId(optional): string
• supplierName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":""
        },
        "action":{
            "type":"string",
            "description":""
        },
        "autoAuth":{
            "type":"string",
            "description":""
        },
        "modificationStatus":{
            "type":"string",
            "description":""
        },
        "datasegmentCode":{
            "type":"string",
            "description":""
        },
        "checkerRemarks":{
            "type":"string",
            "description":""
        },
        "makerRemarks":{
            "type":"string",
            "description":""
        },
        "supplierId":{
            "type":"string",
            "description":""
        },
        "supplierName":{
            "type":"string",
            "description":""
        },
        "ObscfcmTmSupplierCommodityDetailsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObscfcmTmSupplierCommodityDetailsDTO"
            }
        }
    }
}

Nested Schema : ObscfcmTmSupplierCommodityDetailsDTO

Type: array

Show Source

• Array of: object ObscfcmTmSupplierCommodityDetailsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObscfcmTmSupplierCommodityDetailsDTO"
    }
}

Nested Schema : ObscfcmTmSupplierCommodityDetailsDTO

Type: object

Show Source

• commodityCode(optional): string
  Commodity Code
• commodityName(optional): string
  Commodity Name
• countryOfOrigin(optional): string
  Country of origin
• description(optional): string
  Description
• discount(optional): number
  Discount
• id(optional): string
  ID
• ObscfcmTmCommodityUnitsDTO(optional): array ObscfcmTmCommodityUnitsDTO
• supplierCommodityMasterId(optional): string
  Supplier Commodity Master Id
• tax(optional): number
  Tax
• year(optional): number
  Year

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "commodityCode":{
            "type":"string",
            "description":"Commodity Code"
        },
        "commodityName":{
            "type":"string",
            "description":"Commodity Name"
        },
        "countryOfOrigin":{
            "type":"string",
            "description":"Country of origin"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "discount":{
            "type":"number",
            "description":"Discount"
        },
        "supplierCommodityMasterId":{
            "type":"string",
            "description":"Supplier Commodity Master Id"
        },
        "tax":{
            "type":"number",
            "description":"Tax"
        },
        "year":{
            "type":"number",
            "description":"Year"
        },
        "ObscfcmTmCommodityUnitsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObscfcmTmCommodityUnitsDTO"
            }
        }
    }
}

Nested Schema : ObscfcmTmCommodityUnitsDTO

Type: array

Show Source

• Array of: object ObscfcmTmCommodityUnitsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObscfcmTmCommodityUnitsDTO"
    }
}

Nested Schema : ObscfcmTmCommodityUnitsDTO

Type: object

Show Source

• id(optional): string
  Id
• maximumUnit(optional): number
  Maximum Unit
• minimumUnit(optional): number
  Minimum Unit
• supplierCommodityDetailsId(optional): string
  Supplier Commodity Details Id
• unit(optional): string
  Unit
• unitPrice(optional): number
  Unit Price

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "supplierCommodityDetailsId":{
            "type":"string",
            "description":"Supplier Commodity Details Id"
        },
        "maximumUnit":{
            "type":"number",
            "description":"Maximum Unit"
        },
        "minimumUnit":{
            "type":"number",
            "description":"Minimum Unit"
        },
        "unit":{
            "type":"string",
            "description":"Unit"
        },
        "unitPrice":{
            "type":"number",
            "description":"Unit Price"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top