Inventory_batches

>>>

GET /api/shopify/inventory_batches
List of inventory batches based on pagination, search, and filter (by variant ID or location ID or both).

Errors

Code Description
401 The provided token is invalid

Examples

// invalid token
GET /api/shopify/inventory_batches?location_id=1000&variant_id=2000&page=1&search=Inventory+Batch
401
HTTP Token: Access denied.

// valid token
GET /api/shopify/inventory_batches?location_id=1000&variant_id=2000&page=1&search=Inventory+Batch
200
[
  {
    "id": 4037,
    "quantity": 55,
    "expired_at": null,
    "expiry_date": "2023-07-13 05:48:06 UTC",
    "received_date": "2023-07-03 05:48:06 UTC",
    "metadata": {
      "batch_name": "Inventory Batch"
    },
    "created_at": "2023-07-03 05:48:06 UTC",
    "updated_at": "2023-07-03 05:48:06 UTC",
    "notified_at": null,
    "discounted": false,
    "location_id": 1000,
    "variant_id": 2000
  }
]

Params

Param name Description
location_id
optional

Shopify location ID

Validations:

  • Must be a Integer
variant_id
optional

Shopify variant ID

Validations:

  • Must be a Integer
page
optional

Page number

Validations:

  • Must be a Integer
search
optional

Search by inventory batch batch_name, batch_number, barcode, invoice_number description or product title or variant title or barcode

Validations:

  • Must be a String

Headers

Header name Description
Authorization
required 		Bearer token
>>>

GET /api/shopify/inventory_batches/:id
Show inventory batch

Errors

Code Description
401 The provided token is invalid
404 Record not found

Examples

// valid token
GET /api/shopify/inventory_batches/4029
200
{
  "id": 4029,
  "quantity": 55,
  "expired_at": null,
  "expiry_date": "2023-07-13 05:48:05 UTC",
  "received_date": "2023-07-03 05:48:05 UTC",
  "metadata": {
    "batch_name": "Inventory Batch"
  },
  "created_at": "2023-07-03 05:48:05 UTC",
  "updated_at": "2023-07-03 05:48:05 UTC",
  "notified_at": null,
  "discounted": false,
  "location_id": 1000,
  "variant_id": 2000
}
// invalid id
GET /api/shopify/inventory_batches/4031
404
Record not found
// invalid token
GET /api/shopify/inventory_batches/4032
401
HTTP Token: Access denied.

Params

Param name Description
id
required

Inventory batch ID

Validations:

  • Must be a Integer

Headers

Header name Description
Authorization
required 		Bearer token
>>>

POST /api/shopify/inventory_batches
Create inventory batch

Errors

Code Description
401 The provided token is invalid
422 Could not process parameters

Examples

// invalid params
POST /api/shopify/inventory_batches
inventory_batch[quantity]=55
422
Location must exist and Variant must exist
// invalid token
POST /api/shopify/inventory_batches
enable_shopify_sync=true&inventory_batch[location_id]=1000&inventory_batch[variant_id]=2000&inventory_batch[quantity]=55&inventory_batch[batch_name]=batch_name&inventory_batch[batch_number]=batch_number&inventory_batch[barcode]=barcode&inventory_batch[invoice_number]=invoice_number&inventory_batch[description]=description&inventory_batch[received_date]=2023-07-03
401
HTTP Token: Access denied.

// valid token and params
POST /api/shopify/inventory_batches
enable_shopify_sync=true&inventory_batch[location_id]=1000&inventory_batch[variant_id]=2000&inventory_batch[quantity]=55&inventory_batch[batch_name]=batch_name&inventory_batch[batch_number]=batch_number&inventory_batch[barcode]=barcode&inventory_batch[invoice_number]=invoice_number&inventory_batch[description]=description&inventory_batch[received_date]=2023-07-03
201
{
  "id": 4041,
  "quantity": 55,
  "expired_at": null,
  "expiry_date": null,
  "received_date": "2023-07-03 00:00:00 UTC",
  "metadata": {
    "batch_name": "batch_name",
    "batch_number": "batch_number",
    "barcode": "barcode",
    "invoice_number": "invoice_number",
    "description": "description"
  },
  "created_at": "2023-07-03 05:48:06 UTC",
  "updated_at": "2023-07-03 05:48:06 UTC",
  "notified_at": null,
  "discounted": false,
  "location_id": 1000,
  "variant_id": 2000
}

Params

Param name Description
enable_shopify_sync
optional

Should enable Shopify sync?

Validations:

  • Must be one of: true, false, 1, 0.
inventory_batch
optional

Validations:

  • Must be a Hash
inventory_batch[location_id]
required

Shopify location ID

Validations:

  • Must be a Integer
inventory_batch[variant_id]
required

Shopify variant ID

Validations:

  • Must be a Integer
inventory_batch[quantity]
required

Inventory batch quantity

Validations:

  • Must be a Integer
inventory_batch[batch_name]
optional

Inventory batch name

Validations:

  • Must be a String
inventory_batch[batch_number]
optional

Inventory batch number

Validations:

  • Must be a String
inventory_batch[barcode]
optional

Inventory batch barcode

Validations:

  • Must be a String
inventory_batch[invoice_number]
optional

Inventory batch invoice number

Validations:

  • Must be a String
inventory_batch[description]
optional

Inventory batch description

Validations:

  • Must be a String
inventory_batch[received_date]
optional

Inventory batch received date

Validations:

  • Must be a String

Headers

Header name Description
Authorization
required 		Bearer token
>>>

PUT /api/shopify/inventory_batches/:id
Update inventory batch

Errors

Code Description
401 The provided token is invalid
404 Record not found
422 Could not process parameters

Examples

// valid token and params
PUT /api/shopify/inventory_batches/4025
inventory_batch[quantity]=56&inventory_batch[location_id]=1000&inventory_batch[variant_id]=2000
200
{
  "id": 4025,
  "quantity": 56,
  "expired_at": null,
  "expiry_date": "2023-07-13 05:48:05 UTC",
  "received_date": "2023-07-03 05:48:05 UTC",
  "metadata": {
    "batch_name": "Inventory Batch"
  },
  "created_at": "2023-07-03 05:48:05 UTC",
  "updated_at": "2023-07-03 05:48:05 UTC",
  "notified_at": null,
  "discounted": false,
  "location_id": 1000,
  "variant_id": 2000
}
// invalid params
PUT /api/shopify/inventory_batches/4026
inventory_batch[quantity]=56
422
Location must exist and Variant must exist
// invalid id
PUT /api/shopify/inventory_batches/100
inventory_batch[quantity]=56&inventory_batch[location_id]=1000&inventory_batch[variant_id]=2000
404
Record not found
// invalid token
PUT /api/shopify/inventory_batches/4028
inventory_batch[location_id]=1000&inventory_batch[variant_id]=2000&inventory_batch[quantity]=56&inventory_batch[batch_name]=batch_name&inventory_batch[batch_number]=batch_number&inventory_batch[barcode]=barcode&inventory_batch[invoice_number]=invoice_number&inventory_batch[description]=description&inventory_batch[received_date]=2023-07-03
401
HTTP Token: Access denied.

Params

Param name Description
enable_shopify_sync
optional

Should enable Shopify sync?

Validations:

  • Must be one of: true, false, 1, 0.
inventory_batch
optional

Validations:

  • Must be a Hash
inventory_batch[location_id]
required

Shopify location ID

Validations:

  • Must be a Integer
inventory_batch[variant_id]
required

Shopify variant ID

Validations:

  • Must be a Integer
inventory_batch[quantity]
required

Inventory batch quantity

Validations:

  • Must be a Integer
inventory_batch[batch_name]
optional

Inventory batch name

Validations:

  • Must be a String
inventory_batch[batch_number]
optional

Inventory batch number

Validations:

  • Must be a String
inventory_batch[barcode]
optional

Inventory batch barcode

Validations:

  • Must be a String
inventory_batch[invoice_number]
optional

Inventory batch invoice number

Validations:

  • Must be a String
inventory_batch[description]
optional

Inventory batch description

Validations:

  • Must be a String
inventory_batch[received_date]
optional

Inventory batch received date

Validations:

  • Must be a String

Headers

Header name Description
Authorization
required 		Bearer token
>>>

DELETE /api/shopify/inventory_batches/:id
Delete inventory batch

Errors

Code Description
401 The provided token is invalid
404 Record not found

Examples

// invalid id
DELETE /api/shopify/inventory_batches/100
404
Record not found
// valid token
DELETE /api/shopify/inventory_batches/4034
200
Inventory batch deleted
// invalid token
DELETE /api/shopify/inventory_batches/4035
401
HTTP Token: Access denied.

Params

Param name Description
id
required

Inventory batch ID

Validations:

  • Must be a Integer

Headers

Header name Description
Authorization
required 		Bearer token