Inventory

README.md

Headers

• Authorization: String {staff app token}

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

WarehouseItem.md

Create new warehouse item

• Endpoint: /inventory/warehouse_item
• Method: POST
• Params:
  • item_id: String, Required
  • warehouse_id: String, Required
  • 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
    • 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
      • quantity: Number
      • sku: String
      • status: Object
        • id: String
        • name: String

Warehouse item details

• 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
    • quantity: Number
    • sku: String
    • status: Object
      • id: String
      • name: String

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

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

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

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

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

List variation item

• Endpoint: /inventory/variation_item/list
• Method: GET
• Queries:
  • offset: Number, Optional
  • limit: Number, Optional
  • warehouse_id: String, Required,
  • search: String, Optional, Search: barcode, custom_id,
• Response: JSON
  • error_code: Integer
  • message: String
  • data: Object
    • total: Number
    • data: Array Object
      • id: String
      • barcode: String
      • custom_id: String
      • images: String[]
      • fields: String[]
      • last_imported_price: Number
      • retail_price: Number
      • total_quantity_can_sell: Number
      • weight: Number
      • item: Object
        • id: String
        • custom_id: String
        • name: String

Create new purchase variation item

• Endpoint: /inventory/purchase
• Method: POST
• Params:
  • variation_item_id: String, Required
  • warehouse_id: String, Required
  • sub_warehouse_id: String, Optional
  • quantity: Number, Required,
• Response: JSON
  • error_code: Integer
  • message: String
  • data: Object
  • id: String
  • warehouse_id: String
  • variation_item_id: String
  • quantity: Number
  • sub_warehouse_id: String