POST api/Product/GetProductStock

取得商品庫存

Request Information

URI Parameters

None.

Body Parameters

GetProductStockRequest
NameDescriptionTypeAdditional information
product_id_start

string

None.

product_id_end

string

None.

brand_start

string

None.

brand_end

string

None.

serial_start

string

None.

serial_end

string

None.

serial_detail_start

string

None.

serial_detail_end

string

None.

store_id

string

None.

one_page_count

integer

None.

page_number

integer

None.

exclude_delisted

boolean

None.

exclude_disable

boolean

None.

encrypted_key

string

None.

data_string

string

None.

Request Formats

application/json, text/json

Sample:
{
  "product_id_start": "sample string 1",
  "product_id_end": "sample string 2",
  "brand_start": "sample string 3",
  "brand_end": "sample string 4",
  "serial_start": "sample string 5",
  "serial_end": "sample string 6",
  "serial_detail_start": "sample string 7",
  "serial_detail_end": "sample string 8",
  "store_id": "sample string 9",
  "one_page_count": 10,
  "page_number": 11,
  "exclude_delisted": true,
  "exclude_disable": true,
  "encrypted_key": "sample string 14",
  "data_string": "sample string 15"
}

application/xml, text/xml

Sample:
<GetProductStockRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoodApi.API_DataTransferObject">
  <data_string>sample string 15</data_string>
  <encrypted_key>sample string 14</encrypted_key>
  <brand_end>sample string 4</brand_end>
  <brand_start>sample string 3</brand_start>
  <exclude_delisted>true</exclude_delisted>
  <exclude_disable>true</exclude_disable>
  <one_page_count>10</one_page_count>
  <page_number>11</page_number>
  <product_id_end>sample string 2</product_id_end>
  <product_id_start>sample string 1</product_id_start>
  <serial_detail_end>sample string 8</serial_detail_end>
  <serial_detail_start>sample string 7</serial_detail_start>
  <serial_end>sample string 6</serial_end>
  <serial_start>sample string 5</serial_start>
  <store_id>sample string 9</store_id>
</GetProductStockRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetProductStockResponse
NameDescriptionTypeAdditional information
data

Collection of GetProductStockAPIDTO

None.

total_number_of_pages

integer

None.

error_code

integer

None.

error_msg

string

None.

logs

Collection of string

None.

error_logs

Collection of Exception

None.

data_string

string

None.

dec_request

string

None.

dec_response

string

None.

Response Formats

application/json, text/json

Sample:
{
  "data": [
    {
      "product_id": "sample string 1",
      "product_name": "sample string 2",
      "inventory_quantity": 3,
      "uncollected_arrival_quantity": 4,
      "pending_sales_quantity": 5
    },
    {
      "product_id": "sample string 1",
      "product_name": "sample string 2",
      "inventory_quantity": 3,
      "uncollected_arrival_quantity": 4,
      "pending_sales_quantity": 5
    }
  ],
  "total_number_of_pages": 1,
  "error_code": 2,
  "error_msg": "sample string 3",
  "logs": [
    "sample string 1",
    "sample string 2"
  ],
  "error_logs": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "data_string": "sample string 4",
  "dec_request": "sample string 5",
  "dec_response": "sample string 6"
}

application/xml, text/xml

Sample:
<GetProductStockResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FoodApi.API_DataTransferObject">
  <data_string>sample string 4</data_string>
  <dec_request>sample string 5</dec_request>
  <dec_response>sample string 6</dec_response>
  <error_code>2</error_code>
  <error_logs xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </error_logs>
  <error_msg>sample string 3</error_msg>
  <logs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </logs>
  <total_number_of_pages>1</total_number_of_pages>
  <data>
    <GetProductStockAPIDTO>
      <inventory_quantity>3</inventory_quantity>
      <pending_sales_quantity>5</pending_sales_quantity>
      <product_id>sample string 1</product_id>
      <product_name>sample string 2</product_name>
      <uncollected_arrival_quantity>4</uncollected_arrival_quantity>
    </GetProductStockAPIDTO>
    <GetProductStockAPIDTO>
      <inventory_quantity>3</inventory_quantity>
      <pending_sales_quantity>5</pending_sales_quantity>
      <product_id>sample string 1</product_id>
      <product_name>sample string 2</product_name>
      <uncollected_arrival_quantity>4</uncollected_arrival_quantity>
    </GetProductStockAPIDTO>
  </data>
</GetProductStockResponse>