Create Barcode

POST 
/api/v1/barcode

Create Barcode

Request

application/json

Body

array

• Array [

entityType stringrequired

Possible values: [po, item, packaging]

The type of entity.

code stringrequired

Barcode

customId string

required when entityType is po or item

poCustomId string

required when entityType is packaging

itemCustomId string

required when entityType is packaging

assortmentCustomId string

define this if this is assortment

format BarcodeFormat (string)

Possible values: [Generic, UPC-A, UPC-E, EAN-8, EAN-13, UPC-EAN, Code-39, Code-93, Code-128, Codebar, ITF, QRCode, DataMatrix, Aztec, PDF417, MaxiCode, RSS-14, RSS-Expanded]

Default value: Generic

Barcode format. If not send, it will use default value.

• ]

Responses

200

All Items are created

application/json

Schema

Schema

• Array [

entityType string

Possible values: [po, item, packaging]

The type of entity.

customId string

required when entityType is po or item

poCustomId string

required when entityType is packaging

itemCustomId string

required when entityType is packaging

assortmentCustomId string

define this if this is assortment

format BarcodeFormat (string)

Possible values: [Generic, UPC-A, UPC-E, EAN-8, EAN-13, UPC-EAN, Code-39, Code-93, Code-128, Codebar, ITF, QRCode, DataMatrix, Aztec, PDF417, MaxiCode, RSS-14, RSS-Expanded]

Default value: Generic

Barcode format. If not send, it will use default value.

status

object

code integer

200 for success, 400 for failure

message string

Success or failure message

• ]

Example (from schema)

[
  {
    "entityType": "po",
    "customId": "string",
    "poCustomId": "string",
    "itemCustomId": "string",
    "assortmentCustomId": "string",
    "format": "Generic",
    "status": {
      "code": 0,
      "message": "string"
    }
  }
]

207

Only some items are created

application/json

Schema

Schema

• Array [

entityType string

Possible values: [po, item, packaging]

The type of entity.

customId string

required when entityType is po or item

poCustomId string

required when entityType is packaging

itemCustomId string

required when entityType is packaging

assortmentCustomId string

define this if this is assortment

format BarcodeFormat (string)

Possible values: [Generic, UPC-A, UPC-E, EAN-8, EAN-13, UPC-EAN, Code-39, Code-93, Code-128, Codebar, ITF, QRCode, DataMatrix, Aztec, PDF417, MaxiCode, RSS-14, RSS-Expanded]

Default value: Generic

Barcode format. If not send, it will use default value.

status

object

code integer

200 for success, 400 for failure

message string

Success or failure message

• ]

Example (from schema)

[
  {
    "entityType": "po",
    "customId": "string",
    "poCustomId": "string",
    "itemCustomId": "string",
    "assortmentCustomId": "string",
    "format": "Generic",
    "status": {
      "code": 0,
      "message": "string"
    }
  }
]

400

Bad request

application/json

Schema

Schema

• Array [

entityType string

Possible values: [po, item, packaging]

The type of entity.

customId string

required when entityType is po or item

poCustomId string

required when entityType is packaging

itemCustomId string

required when entityType is packaging

assortmentCustomId string

define this if this is assortment

format BarcodeFormat (string)

Possible values: [Generic, UPC-A, UPC-E, EAN-8, EAN-13, UPC-EAN, Code-39, Code-93, Code-128, Codebar, ITF, QRCode, DataMatrix, Aztec, PDF417, MaxiCode, RSS-14, RSS-Expanded]

Default value: Generic

Barcode format. If not send, it will use default value.

status

object

code integer

200 for success, 400 for failure

message string

Success or failure message

• ]

Example (from schema)

[
  {
    "entityType": "po",
    "customId": "string",
    "poCustomId": "string",
    "itemCustomId": "string",
    "assortmentCustomId": "string",
    "format": "Generic",
    "status": {
      "code": 0,
      "message": "string"
    }
  }
]

401

Unauthorized

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCode string
message string

Example (from schema)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCode string
errors object
message string

Example (from schema)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Loading...