Skip to content

Instantly share code, notes, and snippets.

@huetran97

huetran97/Item.md

Last active December 10, 2019 09:51
Show Gist options
  • Save huetran97/0ffb2b9ff405f89aaa0ae33a9dfba362 to your computer and use it in GitHub Desktop.
Save huetran97/0ffb2b9ff405f89aaa0ae33a9dfba362 to your computer and use it in GitHub Desktop.
Download ZIP
Inventory
Raw
README.md

Headers

  • Authorization: String {staff app token}
Raw
Item.md

List item

  • Endpoint: /inventory/item/list
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
    • name: String,
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • name: String
        • description: Number
        • local_id: String
        • unit_id: Object
          • id: String
          • name: String
Raw
Log.md

Log Warehouse items

  • Endpoint: /inventory/log
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
    • warehouse_item_id: String, Required
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • api: Number
        • args: String
        • staff: Object
          • id: String
          • email: String
          • avatar: String
          • phone_number: String
Raw
SubWarehouse.md

List sub warehouse

  • Endpoint: /inventory/sub_warehouse/list
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
    • name: Number, Optional
    • warehouse_id: Number, Required
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • name: String
Raw
Warehouse.md

List warehouse

  • Endpoint: /inventory/warehouse/list
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
    • name: String, Optional
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • name: String
        • description: String

Warehouse details

  • Endpoint: /inventory/warehouse/{warehouse_id}
  • Method: GET
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • id: String
      • name:String
      • descripton: String
      • local_id: String
Raw
WarehouseItem.md

Create new warehouse item

  • Endpoint: /inventory/warehouse_item
  • Method: POST
  • Params:
    • item_id: String, Required
    • warehouse_id: String, Required
    • sub_warehouse_id: String, Optional
    • quantity: Number, Required,
    • sku: String, Required
    • status_id: String, Optional
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • id: String
      • warehouse_id: String
      • item_id: String
      • quantity: Number
      • sub_warehouse_id: String
      • status_id: String
      • created_timestamp: Number
      • sku: String

Update status warehouse item

  • Endpoint: /inventory/warehouse_item/update-status
  • Method: PATCH
  • Params:
    • id: String, Required
    • status_id: String, Required
    • note: String, Optional
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • id: String
      • warehouse_id: String
      • item_id: String
      • quantity: Number
      • sub_warehouse_id: String
      • status_id: String
      • created_timestamp: Number
      • sku: String

Move warehouse item

  • Endpoint: /inventory/warehouse_item
  • Method: PATCH
  • Params:
    • new_warehouse_id: String, Required
    • id: String, Required
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • id: String
      • warehouse_id: String
      • item_id: String
      • quantity: Number
      • status_id: String
      • created_timestamp: Number
      • sku: String

List warehouse item

  • Endpoint: /inventory/warehouse_item/list
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
    • warehouse_id: String, Required,
    • sku: String, Optional
    • status_id: String, Optional
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • item: Object
          • id: String
          • name: String
          • unit: Object
            • id: String
            • name: String
          • description: String
          • local_id: String
        • quantity: Number
        • sku: String
        • status: Object
          • id: String
          • name: String
          • color: String
          • item_can_active: Boolean

Warehouse item details by id

  • Endpoint: /inventory/warehouse_item/{warehouse_item_id}
  • Method: GET
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Array Object
      • id: String
      • item: Object
        • id: String
        • name: String
        • unit: Object
          • id: String
          • name: String
        • description: String
        • local_id: String
      • quantity: Number
      • sku: String
      • status: Object
        • id: String
        • name: String
        • color: String
        • item_can_active: Boolean

Warehouse item details by sku

  • Endpoint: /inventory/warehouse_item/by-sku
  • Method: GET
  • Query:
    • sku: String, Required
    • warehouse_id: String, Optional
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Array Object
      • id: String
      • item: Object
        • id: String
        • name: String
        • unit: Object
          • id: String
          • name: String
        • description: String
        • local_id: String
      • quantity: Number
      • sku: String
      • status: Object
        • id: String
        • name: String
        • color: String
        • item_can_active: Boolean
Raw
WarehouseItemStatus.md

List warehouse item status

  • Endpoint: /inventory/warehouse_item_status/list
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • name: String
        • color: String
Raw
WarehouseItemTracking.md

List warehouse item tracking

  • Endpoint: /inventory/tracking/list
  • Method: GET
  • Queries:
    • offset: Number, Optional
    • limit: Number, Optional
    • sku: String, Optional
    • ref_type: String {ADD_WAREHOUSE_ITEM, MOVE_WAREHOUSE_ITEM}
  • Response: JSON
    • error_code: Integer
    • message: String
    • data: Object
      • total: Number
      • data: Array Object
        • id: String
        • warehouse_item_id: String
        • description: String
        • ref_type: String {ADD_WAREHOUSE_ITEM, MOVE_WAREHOUSE_ITEM}
        • timestamp: Number
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment