Skip to main content
API docs by Redocly

Hubble API (3.50.1)

Booking

Retrieves the collection of Booking resources.

Retrieves the collection of Booking resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

bookingNumber
string
bookingReference
string
bookingStatus.code
string
bookingStatus.code[]
Array of strings
qualityControlStatus.code
string
qualityControlStatus.code[]
Array of strings
company.id
integer
company.id[]
Array of integers
portOfLoading.code
string
portOfDischarge.code
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
bookingStatus.code[between]
string
bookingStatus.code[gt]
string
bookingStatus.code[gte]
string
bookingStatus.code[lt]
string
bookingStatus.code[lte]
string
qualityControlStatus.code[between]
string
qualityControlStatus.code[gt]
string
qualityControlStatus.code[gte]
string
qualityControlStatus.code[lt]
string
qualityControlStatus.code[lte]
string
order[id]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[bookingNumber]
string
Enum: "asc" "desc"
json_contains_attributes
string
Example: json_contains_attributes=urlsafebase64encode('{"needle": {"code": "lorem ipsum"}, "path": "$.nestedPath"}')

URL-safe base64 encoded JSON string with required "needle" key and optional "path" key.

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Booking resource.

Creates a Booking resource.

Authorizations:
apiKey
Request Body schema:

The new Booking resource

bookingNumber
string or null
required
(Company.jsonld-metadata.write_booking.write (object or null))

Many Booking have One Company.

bookingDate
string or null <date-time>
bookingReference
string or null
Array of objects (BookingLineItem.jsonld-metadata.write_booking.write)
cargoAvailabilityDate
string or null <date-time>
cutoffDate
string or null <date-time>
estimatedTimeOfArrival
string or null <date-time>
estimatedTimeOfDeparture
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
estimatedVehicle
string or null
estimatedVoyage
string or null
(Carrier.jsonld-metadata.write_booking.write (object or null))

Many Booking have One Carrier.

qualityControlDate
string or null <date-time>
(Status.jsonld-metadata.write_booking.write (object or null))
(Status.jsonld-metadata.write_booking.write (object or null))
(Status.jsonld-metadata.write_booking.write (object or null))
bookingConfirmationDate
string or null <date-time>
shippingOrderEstimatedTimeOfDeparture
string or null <date-time>
consolidationNumber
string or null
consigneeComment
string or null
shipperComment
string or null
Array of objects (BookingAttribute.jsonld-metadata.write_booking.write)
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
object or null
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
(Connection.jsonld-metadata.write_booking.write (object or null))
(Connection.jsonld-metadata.write_booking.write (object or null))
containersBooked
string or null
containerFreightStationPlannedInboundDate
string or null <date-time>
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
eta
string or null <date-time>
etd
string or null <date-time>

Responses

Request samples

Content type
{
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Retrieves a Booking resource.

Retrieves a Booking resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Replaces the Booking resource.

Replaces the Booking resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Booking resource

bookingNumber
string or null
required
(Company.jsonld-metadata.write_booking.write (object or null))

Many Booking have One Company.

bookingDate
string or null <date-time>
bookingReference
string or null
Array of objects (BookingLineItem.jsonld-metadata.write_booking.write)
cargoAvailabilityDate
string or null <date-time>
cutoffDate
string or null <date-time>
estimatedTimeOfArrival
string or null <date-time>
estimatedTimeOfDeparture
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
estimatedVehicle
string or null
estimatedVoyage
string or null
(Carrier.jsonld-metadata.write_booking.write (object or null))

Many Booking have One Carrier.

qualityControlDate
string or null <date-time>
(Status.jsonld-metadata.write_booking.write (object or null))
(Status.jsonld-metadata.write_booking.write (object or null))
(Status.jsonld-metadata.write_booking.write (object or null))
bookingConfirmationDate
string or null <date-time>
shippingOrderEstimatedTimeOfDeparture
string or null <date-time>
consolidationNumber
string or null
consigneeComment
string or null
shipperComment
string or null
Array of objects (BookingAttribute.jsonld-metadata.write_booking.write)
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
object or null
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
(ReferenceCode.jsonld-metadata.write_booking.write (object or null))
(Connection.jsonld-metadata.write_booking.write (object or null))
(Connection.jsonld-metadata.write_booking.write (object or null))
containersBooked
string or null
containerFreightStationPlannedInboundDate
string or null <date-time>
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
eta
string or null <date-time>
etd
string or null <date-time>

Responses

Request samples

Content type
{
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Removes the Booking resource.

Removes the Booking resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the Booking resource.

Updates the Booking resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Booking resource

bookingNumber
string or null
required
(Company-metadata.write_booking.write (object or null))

Many Booking have One Company.

bookingDate
string or null <date-time>
bookingReference
string or null
Array of objects (BookingLineItem-metadata.write_booking.write)
cargoAvailabilityDate
string or null <date-time>
cutoffDate
string or null <date-time>
estimatedTimeOfArrival
string or null <date-time>
estimatedTimeOfDeparture
string or null <date-time>
(ReferenceCode-metadata.write_booking.write (object or null))
estimatedVehicle
string or null
estimatedVoyage
string or null
(Carrier-metadata.write_booking.write (object or null))

Many Booking have One Carrier.

qualityControlDate
string or null <date-time>
(Status-metadata.write_booking.write (object or null))
(Status-metadata.write_booking.write (object or null))
(Status-metadata.write_booking.write (object or null))
bookingConfirmationDate
string or null <date-time>
shippingOrderEstimatedTimeOfDeparture
string or null <date-time>
consolidationNumber
string or null
consigneeComment
string or null
shipperComment
string or null
Array of objects (BookingAttribute-metadata.write_booking.write)
(ReferenceCode-metadata.write_booking.write (object or null))
object or null
(ReferenceCode-metadata.write_booking.write (object or null))
(ReferenceCode-metadata.write_booking.write (object or null))
(ReferenceCode-metadata.write_booking.write (object or null))
(Connection-metadata.write_booking.write (object or null))
(Connection-metadata.write_booking.write (object or null))
containersBooked
string or null
containerFreightStationPlannedInboundDate
string or null <date-time>
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
eta
string or null <date-time>
etd
string or null <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "bookingNumber": "string",
  • "company": {
    },
  • "bookingDate": "2019-08-24T14:15:22Z",
  • "bookingReference": "string",
  • "bookingLineItems": [
    ],
  • "cargoAvailabilityDate": "2019-08-24T14:15:22Z",
  • "cutoffDate": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "mainTransportType": {
    },
  • "estimatedVehicle": "string",
  • "estimatedVoyage": "string",
  • "estimatedCarrier": {
    },
  • "qualityControlDate": "2019-08-24T14:15:22Z",
  • "qualityControlStatus": {
    },
  • "bookingStatus": {
    },
  • "confirmationStatusByCustomer": {
    },
  • "bookingConfirmationDate": "2019-08-24T14:15:22Z",
  • "shippingOrderEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "consolidationNumber": "string",
  • "consigneeComment": "string",
  • "shipperComment": "string",
  • "bookingAttributes": [
    ],
  • "priorityRanking": {
    },
  • "attributes": {
    },
  • "loadingType": {
    },
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "containersBooked": "string",
  • "containerFreightStationPlannedInboundDate": "2019-08-24T14:15:22Z",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z"
}

Connection

Retrieves the collection of Connection resources.

Retrieves the collection of Connection resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

name
string
code
string
code[]
Array of strings
country
string
relationship
string
relationship[]
Array of strings
company.id
integer
company.id[]
Array of integers

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Connection resource.

Creates a Connection resource.

Authorizations:
apiKey
Request Body schema:

The new Connection resource

name
string or null
code
string or null
relationship
string or null
note
string or null
wmsCode
string or null
preferredCurrency
(Contact.jsonld-metadata.write_connection.write (object or null))

Many Connection have one Contact

Connection.jsonld-metadata.write_connection.write (object)
Array of objects (Address.jsonld-metadata.write_connection.write)
lastUsed
string or null <date-time>
(Company.jsonld-metadata.write_connection.write (object or null))

Many Connection have One Company

shippingAddress
string or null

Temporary workaround for shipping information before revamping Connection+Address

shippingPhone
string or null

Temporary workaround for shipping information before revamping Connection+Address

releaseThreshold
number or null
invoicedAtRetailPrice
boolean
active
boolean
businessRegistrationNumber
string or null
businessRegistrationType
string or null
latitude
number or null
longitude
number or null
countryCode
required
string or null
country
string or null
state
string or null
city
string or null
district
string or null
zipcode
string or null
streetAddress
string or null
streetAddress2
string or null
streetAddress3
string or null
phone
string or null
fax
string or null
externalId
string or null
(Warehouse.jsonld-metadata.write_connection.write (object or null))
object or null
object or null
(ReferenceCode.jsonld-metadata.write_connection.write (object or null))
(ReferenceCode.jsonld-metadata.write_connection.write (object or null))
consigneeId
string or null
notifyId
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a Connection resource.

Retrieves a Connection resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the Connection resource.

Replaces the Connection resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Connection resource

name
string or null
code
string or null
relationship
string or null
note
string or null
wmsCode
string or null
preferredCurrency
(Contact.jsonld-metadata.write_connection.write (object or null))

Many Connection have one Contact

Connection.jsonld-metadata.write_connection.write (object)
Array of objects (Address.jsonld-metadata.write_connection.write)
lastUsed
string or null <date-time>
(Company.jsonld-metadata.write_connection.write (object or null))

Many Connection have One Company

shippingAddress
string or null

Temporary workaround for shipping information before revamping Connection+Address

shippingPhone
string or null

Temporary workaround for shipping information before revamping Connection+Address

releaseThreshold
number or null
invoicedAtRetailPrice
boolean
active
boolean
businessRegistrationNumber
string or null
businessRegistrationType
string or null
latitude
number or null
longitude
number or null
countryCode
required
string or null
country
string or null
state
string or null
city
string or null
district
string or null
zipcode
string or null
streetAddress
string or null
streetAddress2
string or null
streetAddress3
string or null
phone
string or null
fax
string or null
externalId
string or null
(Warehouse.jsonld-metadata.write_connection.write (object or null))
object or null
object or null
(ReferenceCode.jsonld-metadata.write_connection.write (object or null))
(ReferenceCode.jsonld-metadata.write_connection.write (object or null))
consigneeId
string or null
notifyId
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the Connection resource.

Removes the Connection resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the Connection resource.

Updates the Connection resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Connection resource

name
string or null
code
string or null
relationship
string or null
note
string or null
wmsCode
string or null
preferredCurrency
(Contact-metadata.write_connection.write (object or null))

Many Connection have one Contact

Connection-metadata.write_connection.write (object)
Array of objects (Address-metadata.write_connection.write)
lastUsed
string or null <date-time>
(Company-metadata.write_connection.write (object or null))

Many Connection have One Company

shippingAddress
string or null

Temporary workaround for shipping information before revamping Connection+Address

shippingPhone
string or null

Temporary workaround for shipping information before revamping Connection+Address

releaseThreshold
number or null
invoicedAtRetailPrice
boolean
active
boolean
businessRegistrationNumber
string or null
businessRegistrationType
string or null
latitude
number or null
longitude
number or null
countryCode
required
string or null
country
string or null
state
string or null
city
string or null
district
string or null
zipcode
string or null
streetAddress
string or null
streetAddress2
string or null
streetAddress3
string or null
phone
string or null
fax
string or null
externalId
string or null
(Warehouse-metadata.write_connection.write (object or null))
object or null
object or null
(ReferenceCode-metadata.write_connection.write (object or null))
(ReferenceCode-metadata.write_connection.write (object or null))
consigneeId
string or null
notifyId
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "relationship": "string",
  • "note": "string",
  • "wmsCode": "string",
  • "preferredCurrency": "string",
  • "contact": {
    },
  • "billTo": { },
  • "addresses": [
    ],
  • "lastUsed": "2019-08-24T14:15:22Z",
  • "company": {
    },
  • "shippingAddress": "string",
  • "shippingPhone": "string",
  • "releaseThreshold": 0,
  • "invoicedAtRetailPrice": true,
  • "active": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "businessRegistrationNumber": "string",
  • "businessRegistrationType": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "countryCode": "string",
  • "country": "string",
  • "state": "string",
  • "city": "string",
  • "district": "string",
  • "zipcode": "string",
  • "streetAddress": "string",
  • "streetAddress2": "string",
  • "streetAddress3": "string",
  • "phone": "string",
  • "fax": "string",
  • "externalId": "string",
  • "warehouse": {
    },
  • "externalData": {
    },
  • "attributes": {
    },
  • "controllingCustomer": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "consigneeId": "string",
  • "notifyId": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Document

Retrieves the collection of Document resources.

Retrieves the collection of Document resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

company.id
integer
company.id[]
Array of integers
entityId
integer
entityId[]
Array of integers
entityType
string
entityType[]
Array of strings

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Document resource.

Creates a Document resource.

Authorizations:
apiKey
Request Body schema:

The new Document resource

entityType
string
entityId
integer or null

soft link to entity

company
string or null <iri-reference>

Many Document may have One Company.

documentName
string or null
contentUrl
file
string or null <binary>
filePath
string or null
documentType
string or null <iri-reference>

Many ExtractRequest have One ReferenceCode as extraction status.

mediaType
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "entityType": "string",
  • "entityId": 0,
  • "company": "../словник",
  • "documentName": "string",
  • "contentUrl": "string",
  • "file": "string",
  • "filePath": "string",
  • "documentType": "../словник",
  • "mediaType": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "entityType": "string",
  • "entityId": 0,
  • "company": {
    },
  • "documentName": "string",
  • "contentUrl": "string",
  • "filePath": "string",
  • "documentType": {
    },
  • "mediaType": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a Document resource.

Retrieves a Document resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "entityType": "string",
  • "entityId": 0,
  • "company": {
    },
  • "documentName": "string",
  • "contentUrl": "string",
  • "filePath": "string",
  • "documentType": {
    },
  • "mediaType": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the Document resource.

Replaces the Document resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Document resource

entityType
string
entityId
integer or null

soft link to entity

(Company.jsonld-metadata.write_document.write (object or null))

Many Document may have One Company.

documentName
string or null
filePath
string or null
(ReferenceCode.jsonld-metadata.write_document.write (object or null))

Many ExtractRequest have One ReferenceCode as extraction status.

mediaType
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "entityType": "string",
  • "entityId": 0,
  • "company": {
    },
  • "documentName": "string",
  • "filePath": "string",
  • "documentType": {
    },
  • "mediaType": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "entityType": "string",
  • "entityId": 0,
  • "company": {
    },
  • "documentName": "string",
  • "contentUrl": "string",
  • "filePath": "string",
  • "documentType": {
    },
  • "mediaType": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the Document resource.

Removes the Document resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the Document resource.

Updates the Document resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Document resource

entityType
string
entityId
integer or null

soft link to entity

(Company-metadata.write_document.write (object or null))

Many Document may have One Company.

documentName
string or null
filePath
string or null
(ReferenceCode-metadata.write_document.write (object or null))

Many ExtractRequest have One ReferenceCode as extraction status.

mediaType
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "entityType": "string",
  • "entityId": 0,
  • "company": {
    },
  • "documentName": "string",
  • "filePath": "string",
  • "documentType": {
    },
  • "mediaType": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "entityType": "string",
  • "entityId": 0,
  • "company": {
    },
  • "documentName": "string",
  • "contentUrl": "string",
  • "filePath": "string",
  • "documentType": {
    },
  • "mediaType": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

PurchaseOrder

Retrieves the collection of PurchaseOrder resources.

Retrieves the collection of PurchaseOrder resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

orderNumber
string
supplier.name
string
supplier.code
string
supplier.code[]
Array of strings
company.id
integer
company.id[]
Array of integers
warehouseLocation.name
string
warehouseLocation.code
string
warehouseLocation.code[]
Array of strings
status
string
status[]
Array of strings
status.code
string
status.code[]
Array of strings
orderOrigin
string
orderOrigin[]
Array of strings
carrier
string
carrier[]
Array of strings
carrier.code
string
carrier.code[]
Array of strings
trackingNumber
string
orderType
string
referenceNumber
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
receivedAt[before]
string
receivedAt[strictly_before]
string
receivedAt[after]
string
receivedAt[strictly_after]
string
exists[receivedAt]
boolean
order[id]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[orderNumber]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a PurchaseOrder resource.

Creates a PurchaseOrder resource.

Authorizations:
apiKey
Request Body schema:

The new PurchaseOrder resource

orderNumber
string or null
orderOrigin
string or null
orderType
string or null
orderTypeString
string or null
referenceNumber
string or null
trackingNumber
string or null
(Carrier.jsonld-metadata.write_purchase_order.write (object or null))
issuedAt
string or null <date-time>
dueAt
string or null <date-time>
receivedAt
string or null <date-time>
required
(Connection.jsonld-metadata.write_purchase_order.write (object or null))
entry
string or null
(Connection.jsonld-metadata.write_purchase_order.write (object or null))
Array of objects (PurchaseOrderLineItem.jsonld-metadata.write_purchase_order.write)
required
(Company.jsonld-metadata.write_purchase_order.write (object or null))
(Warehouse.jsonld-metadata.write_purchase_order.write (object or null))
total
integer
(ReferenceCode.jsonld-metadata.write_purchase_order.write (object or null))
Array of objects (PurchaseOrderEvent.jsonld-metadata.write_purchase_order.write)

One PurchaseOrder has Many PurchaseOrderEvent. (orphanRemoval true will make sure no PurchaseOrderEvent without SalesOrder)

sourcingOffice
string or null
object or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsSyncSuccessfulAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a PurchaseOrder resource.

Retrieves a PurchaseOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsSyncSuccessfulAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the PurchaseOrder resource.

Replaces the PurchaseOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated PurchaseOrder resource

orderNumber
string or null
orderOrigin
string or null
orderType
string or null
orderTypeString
string or null
referenceNumber
string or null
trackingNumber
string or null
(Carrier.jsonld-metadata.write_purchase_order.write (object or null))
issuedAt
string or null <date-time>
dueAt
string or null <date-time>
receivedAt
string or null <date-time>
required
(Connection.jsonld-metadata.write_purchase_order.write (object or null))
entry
string or null
(Connection.jsonld-metadata.write_purchase_order.write (object or null))
Array of objects (PurchaseOrderLineItem.jsonld-metadata.write_purchase_order.write)
required
(Company.jsonld-metadata.write_purchase_order.write (object or null))
(Warehouse.jsonld-metadata.write_purchase_order.write (object or null))
total
integer
(ReferenceCode.jsonld-metadata.write_purchase_order.write (object or null))
Array of objects (PurchaseOrderEvent.jsonld-metadata.write_purchase_order.write)

One PurchaseOrder has Many PurchaseOrderEvent. (orphanRemoval true will make sure no PurchaseOrderEvent without SalesOrder)

sourcingOffice
string or null
object or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsSyncSuccessfulAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the PurchaseOrder resource.

Removes the PurchaseOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the PurchaseOrder resource.

Updates the PurchaseOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated PurchaseOrder resource

orderNumber
string or null
orderOrigin
string or null
orderType
string or null
orderTypeString
string or null
referenceNumber
string or null
trackingNumber
string or null
(Carrier-metadata.write_purchase_order.write (object or null))
issuedAt
string or null <date-time>
dueAt
string or null <date-time>
receivedAt
string or null <date-time>
required
(Connection-metadata.write_purchase_order.write (object or null))
entry
string or null
(Connection-metadata.write_purchase_order.write (object or null))
Array of objects (PurchaseOrderLineItem-metadata.write_purchase_order.write)
required
(Company-metadata.write_purchase_order.write (object or null))
(Warehouse-metadata.write_purchase_order.write (object or null))
total
integer
(ReferenceCode-metadata.write_purchase_order.write (object or null))
Array of objects (PurchaseOrderEvent-metadata.write_purchase_order.write)

One PurchaseOrder has Many PurchaseOrderEvent. (orphanRemoval true will make sure no PurchaseOrderEvent without SalesOrder)

sourcingOffice
string or null
object or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "orderOrigin": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "referenceNumber": "string",
  • "trackingNumber": "string",
  • "carrier": {
    },
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "receivedAt": "2019-08-24T14:15:22Z",
  • "supplier": {
    },
  • "entry": "string",
  • "billingTo": {
    },
  • "purchaseOrderLineItems": [
    ],
  • "company": {
    },
  • "warehouseLocation": {
    },
  • "total": 0,
  • "status": {
    },
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsSyncSuccessfulAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "purchaseOrderEvents": [
    ],
  • "sourcingOffice": "string",
  • "attributes": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

SalesOrder

Retrieves the collection of SalesOrder resources.

Retrieves the collection of SalesOrder resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

orderNumber
string
externalOrderNumber
string
fulfillmentStatus
string
fulfillmentStatus[]
Array of strings
fulfillmentStatus.code
string
fulfillmentStatus.code[]
Array of strings
orderOrigin
string
orderOrigin[]
Array of strings
company.id
integer
company.id[]
Array of integers
warehouseLocation.name
string
warehouseLocation.code
string
warehouseLocation.code[]
Array of strings
shipFrom.name
string
shipTo.name
string
mainTransportType.code
string
mainTransportType.code[]
Array of strings
carrier
string
carrier[]
Array of strings
carrier.code
string
carrier.code[]
Array of strings
trackingNumber
string
orderType
string
referenceNumber
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
shippedAt[before]
string
shippedAt[strictly_before]
string
shippedAt[after]
string
shippedAt[strictly_after]
string
paidAt[before]
string
paidAt[strictly_before]
string
paidAt[after]
string
paidAt[strictly_after]
string
dueAt[before]
string
dueAt[strictly_before]
string
dueAt[after]
string
dueAt[strictly_after]
string
fulfillmentStatus.code[between]
string
fulfillmentStatus.code[gt]
string
fulfillmentStatus.code[gte]
string
fulfillmentStatus.code[lt]
string
fulfillmentStatus.code[lte]
string
total[between]
string
total[gt]
string
total[gte]
string
total[lt]
string
total[lte]
string
exists[shippedAt]
boolean
exists[paidAt]
boolean
exists[dueAt]
boolean
order[id]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[orderNumber]
string
Enum: "asc" "desc"
json_contains_attributes
string
Example: json_contains_attributes=urlsafebase64encode('{"needle": {"code": "lorem ipsum"}, "path": "$.nestedPath"}')

URL-safe base64 encoded JSON string with required "needle" key and optional "path" key.

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a SalesOrder resource.

Creates a SalesOrder resource.

Authorizations:
apiKey
Request Body schema:

The new SalesOrder resource

orderNumber
string or null
externalOrderNumber
string or null
issuedAt
string or null <date-time>
comment
string or null
shippedAt
string or null <date-time>
paidAt
string or null <date-time>
dueAt
string or null <date-time>
(Warehouse.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
Array of objects (SalesOrderLineItem.jsonld-metadata.write_sales_order.write)
Array of objects (Shipment.jsonld-metadata.write_sales_order.write)

Many SalesOrders have Many Shipments.

Array of objects (FulfillmentEvent.jsonld-metadata.write_sales_order.write)

One SalesOrder has Many FulfillmentEvent.

Array of objects (SalesOrderAttribute.jsonld-metadata.write_sales_order.write)

One SalesOrder has Many SalesOrderAttribute.

(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))

Many SalesOrder have One FulfillmentStatus

required
object (Company.jsonld-metadata.write_sales_order.write)
(User.jsonld-metadata.write_sales_order.write (object or null))

Many SalesOrders have One User.

referenceNumber
string or null
orderOrigin
string or null
total
integer
totalAmount
number
totalAmountWithTax
number
totalPaidAmount
number
tax
number
totalDiscount
number
currency
totalWeight
number
weightUnit
string or null

Kg, gm, oz or lb

wmsEdiGeneratedAt
string or null <date-time>
outEdiGeneratedAt
string or null <date-time>
orderAcceptedDate
string or null <date-time>
paymentStatus
string or null

Possible unpaid, partial or paid

refundAt
string or null <date-time>
groupCode
string or null
(Carrier.jsonld-metadata.write_sales_order.write (object or null))
trackingNumber
string or null
labelUrl
string or null
orderType
string or null
orderTypeString
string or null
wmsOrderNumber
string or null
version
integer
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
commentDelayReasonFulfillment
string or null
fragile
boolean
presales
boolean
shippingInstructions
string or null
cargoReadyDate
string or null <date-time>
(Connection.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
proformaInvoiceNumber
string or null
proformaInvoiceEstimatedTimeOfDeparture
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
incotermPlace
string or null
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
paymentTerms
string or null
object or null
Array of objects (ShippingUnit.jsonld-metadata.write_sales_order.write)

One SalesOrder has Many ShippingUnits

operationCode
string or null
operationName
string or null
department
string or null
season
string or null
sourcingOffice
string or null
shipperComment
string or null
packingInstructions
string or null
totalVolume
number
volumeUnit
string or null
selectionCriteria
string or null
deliveryMode
string or null
(Channel.jsonld-metadata.write_sales_order.write (object or null))
shippingFee
number
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "labelPrintData": [
    ],
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a SalesOrder resource.

Retrieves a SalesOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "labelPrintData": [
    ],
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the SalesOrder resource.

Replaces the SalesOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated SalesOrder resource

orderNumber
string or null
externalOrderNumber
string or null
issuedAt
string or null <date-time>
comment
string or null
shippedAt
string or null <date-time>
paidAt
string or null <date-time>
dueAt
string or null <date-time>
(Warehouse.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
Array of objects (SalesOrderLineItem.jsonld-metadata.write_sales_order.write)
Array of objects (Shipment.jsonld-metadata.write_sales_order.write)

Many SalesOrders have Many Shipments.

Array of objects (FulfillmentEvent.jsonld-metadata.write_sales_order.write)

One SalesOrder has Many FulfillmentEvent.

Array of objects (SalesOrderAttribute.jsonld-metadata.write_sales_order.write)

One SalesOrder has Many SalesOrderAttribute.

(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))

Many SalesOrder have One FulfillmentStatus

required
object (Company.jsonld-metadata.write_sales_order.write)
(User.jsonld-metadata.write_sales_order.write (object or null))

Many SalesOrders have One User.

referenceNumber
string or null
orderOrigin
string or null
total
integer
totalAmount
number
totalAmountWithTax
number
totalPaidAmount
number
tax
number
totalDiscount
number
currency
totalWeight
number
weightUnit
string or null

Kg, gm, oz or lb

wmsEdiGeneratedAt
string or null <date-time>
outEdiGeneratedAt
string or null <date-time>
orderAcceptedDate
string or null <date-time>
paymentStatus
string or null

Possible unpaid, partial or paid

refundAt
string or null <date-time>
groupCode
string or null
(Carrier.jsonld-metadata.write_sales_order.write (object or null))
trackingNumber
string or null
labelUrl
string or null
orderType
string or null
orderTypeString
string or null
wmsOrderNumber
string or null
version
integer
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
commentDelayReasonFulfillment
string or null
fragile
boolean
presales
boolean
shippingInstructions
string or null
cargoReadyDate
string or null <date-time>
(Connection.jsonld-metadata.write_sales_order.write (object or null))
(Connection.jsonld-metadata.write_sales_order.write (object or null))
proformaInvoiceNumber
string or null
proformaInvoiceEstimatedTimeOfDeparture
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
incotermPlace
string or null
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
(ReferenceCode.jsonld-metadata.write_sales_order.write (object or null))
paymentTerms
string or null
object or null
Array of objects (ShippingUnit.jsonld-metadata.write_sales_order.write)

One SalesOrder has Many ShippingUnits

operationCode
string or null
operationName
string or null
department
string or null
season
string or null
sourcingOffice
string or null
shipperComment
string or null
packingInstructions
string or null
totalVolume
number
volumeUnit
string or null
selectionCriteria
string or null
deliveryMode
string or null
(Channel.jsonld-metadata.write_sales_order.write (object or null))
shippingFee
number
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "labelPrintData": [
    ],
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the SalesOrder resource.

Removes the SalesOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the SalesOrder resource.

Updates the SalesOrder resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated SalesOrder resource

orderNumber
string or null
externalOrderNumber
string or null
issuedAt
string or null <date-time>
comment
string or null
shippedAt
string or null <date-time>
paidAt
string or null <date-time>
dueAt
string or null <date-time>
(Warehouse-metadata.write_sales_order.write (object or null))
(Connection-metadata.write_sales_order.write (object or null))
(Connection-metadata.write_sales_order.write (object or null))
(Connection-metadata.write_sales_order.write (object or null))
Array of objects (SalesOrderLineItem-metadata.write_sales_order.write)
Array of objects (Shipment-metadata.write_sales_order.write)

Many SalesOrders have Many Shipments.

Array of objects (FulfillmentEvent-metadata.write_sales_order.write)

One SalesOrder has Many FulfillmentEvent.

Array of objects (SalesOrderAttribute-metadata.write_sales_order.write)

One SalesOrder has Many SalesOrderAttribute.

(ReferenceCode-metadata.write_sales_order.write (object or null))

Many SalesOrder have One FulfillmentStatus

required
object (Company-metadata.write_sales_order.write)
(User-metadata.write_sales_order.write (object or null))

Many SalesOrders have One User.

referenceNumber
string or null
orderOrigin
string or null
total
integer
totalAmount
number
totalAmountWithTax
number
totalPaidAmount
number
tax
number
totalDiscount
number
currency
totalWeight
number
weightUnit
string or null

Kg, gm, oz or lb

wmsEdiGeneratedAt
string or null <date-time>
outEdiGeneratedAt
string or null <date-time>
orderAcceptedDate
string or null <date-time>
paymentStatus
string or null

Possible unpaid, partial or paid

refundAt
string or null <date-time>
groupCode
string or null
(Carrier-metadata.write_sales_order.write (object or null))
trackingNumber
string or null
labelUrl
string or null
orderType
string or null
orderTypeString
string or null
wmsOrderNumber
string or null
version
integer
(ReferenceCode-metadata.write_sales_order.write (object or null))
(ReferenceCode-metadata.write_sales_order.write (object or null))
commentDelayReasonFulfillment
string or null
fragile
boolean
presales
boolean
shippingInstructions
string or null
cargoReadyDate
string or null <date-time>
(Connection-metadata.write_sales_order.write (object or null))
(Connection-metadata.write_sales_order.write (object or null))
proformaInvoiceNumber
string or null
proformaInvoiceEstimatedTimeOfDeparture
string or null <date-time>
(ReferenceCode-metadata.write_sales_order.write (object or null))
incotermPlace
string or null
(ReferenceCode-metadata.write_sales_order.write (object or null))
(ReferenceCode-metadata.write_sales_order.write (object or null))
paymentTerms
string or null
object or null
Array of objects (ShippingUnit-metadata.write_sales_order.write)

One SalesOrder has Many ShippingUnits

operationCode
string or null
operationName
string or null
department
string or null
season
string or null
sourcingOffice
string or null
shipperComment
string or null
packingInstructions
string or null
totalVolume
number
volumeUnit
string or null
selectionCriteria
string or null
deliveryMode
string or null
(Channel-metadata.write_sales_order.write (object or null))
shippingFee
number
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "orderNumber": "string",
  • "externalOrderNumber": "string",
  • "issuedAt": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "shippedAt": "2019-08-24T14:15:22Z",
  • "paidAt": "2019-08-24T14:15:22Z",
  • "dueAt": "2019-08-24T14:15:22Z",
  • "warehouseLocation": {
    },
  • "shipFrom": {
    },
  • "shipTo": {
    },
  • "billingTo": {
    },
  • "salesOrderLineItems": [
    ],
  • "shipments": [
    ],
  • "fulfillmentEvents": [
    ],
  • "salesOrderAttributes": [
    ],
  • "fulfillmentStatus": {
    },
  • "company": {
    },
  • "assignee": {
    },
  • "referenceNumber": "string",
  • "orderOrigin": "string",
  • "total": 0,
  • "totalAmount": 0,
  • "totalAmountWithTax": 0,
  • "totalPaidAmount": 0,
  • "tax": 0,
  • "totalDiscount": 0,
  • "currency": "string",
  • "totalWeight": 0,
  • "weightUnit": "string",
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "outEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "orderAcceptedDate": "2019-08-24T14:15:22Z",
  • "paymentStatus": "string",
  • "refundAt": "2019-08-24T14:15:22Z",
  • "groupCode": "string",
  • "carrier": {
    },
  • "trackingNumber": "string",
  • "labelUrl": "string",
  • "orderType": "string",
  • "orderTypeString": "string",
  • "wmsOrderNumber": "string",
  • "version": 0,
  • "labelPrintData": [
    ],
  • "mainTransportType": {
    },
  • "delayReasonFulfillment": {
    },
  • "commentDelayReasonFulfillment": "string",
  • "fragile": true,
  • "presales": true,
  • "shippingInstructions": "string",
  • "cargoReadyDate": "2019-08-24T14:15:22Z",
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "proformaInvoiceNumber": "string",
  • "proformaInvoiceEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "incoterm": {
    },
  • "incotermPlace": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "paymentTerms": "string",
  • "attributes": {
    },
  • "shippingUnits": [
    ],
  • "operationCode": "string",
  • "operationName": "string",
  • "department": "string",
  • "season": "string",
  • "sourcingOffice": "string",
  • "shipperComment": "string",
  • "packingInstructions": "string",
  • "totalVolume": 0,
  • "volumeUnit": "string",
  • "selectionCriteria": "string",
  • "deliveryMode": "string",
  • "channel": {
    },
  • "shippingFee": 0,
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Shipment

Retrieves the collection of Shipment resources.

Retrieves the collection of Shipment resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

shipmentNumber
string
company.id
integer
company.id[]
Array of integers
houseBillOfLading
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
completedAt[before]
string
completedAt[strictly_before]
string
completedAt[after]
string
completedAt[strictly_after]
string
order[id]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[shipmentNumber]
string
Enum: "asc" "desc"
json_contains_attributes
string
Example: json_contains_attributes=urlsafebase64encode('{"needle": {"code": "lorem ipsum"}, "path": "$.nestedPath"}')

URL-safe base64 encoded JSON string with required "needle" key and optional "path" key.

draft
boolean

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Create a Shipment resource.

When creating a Shipment with relation to ShippingUnit and ShippingUnitLineItem, Hubble will try to automatically fulfill the SalesOrder by the relation of newly created ShippingUnitLineItem->SalesOrderLineItem.

Authorizations:
apiKey
Request Body schema:

The new Shipment resource

shipmentNumber
string or null
required
(Company.jsonld-metadata.write_shipment.write (object or null))

Many Shipment have One Company.

(Warehouse.jsonld-metadata.write_shipment.write (object or null))

Many SalesOrders have One Location/Warehouse.

(Connection.jsonld-metadata.write_shipment.write (object or null))

Many SalesOrders have One Location/Warehouse.

Array of objects (ShippingUnit.jsonld-metadata.write_shipment.write)

One Shipment has Many ShippingUnit.

Array of objects (ShipmentAttribute.jsonld-metadata.write_shipment.write)

One Shipment has Many ShipmentAttribute.

Array of objects (ShipmentLeg.jsonld-metadata.write_shipment.write)

One Shipment has Many ShipmentLegs.

(ShipmentLog.jsonld-metadata.write_shipment.write (object or null))

One Shipment has One ShipmentLog.

(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(Carrier.jsonld-metadata.write_shipment.write (object or null))

Many Shipment have One Carrier.

vehicle
string or null
voyage
string or null
total
integer or null
totalWeight
integer or null
originalEstimatedTimeOfArrival
string or null <date-time>
originalEstimatedTimeOfDeparture
string or null <date-time>
estimatedTimeOfArrival
string or null <date-time>
estimatedTimeOfDeparture
string or null <date-time>
actualTimeOfArrival
string or null <date-time>
actualTimeOfDeparture
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
comment
string or null
externalData
string or null
containerNumber
string or null
Array of objects (SalesOrder.jsonld-metadata.write_shipment.write)

Many Shipments have Many SalesOrders.

extractStatus
string or null
commentDelayReasonDeparture
string or null
commentDelayReasonArrival
string or null
completedAt
string or null <date-time>
(Connection.jsonld-metadata.write_shipment.write (object or null))
(Connection.jsonld-metadata.write_shipment.write (object or null))
(Connection.jsonld-metadata.write_shipment.write (object or null))
destinationAgentReference
string or null
customsReference
string or null
subscriptionStatus
string or null
(Status.jsonld-metadata.write_shipment.write (object or null))
(Status.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
controllingCustomer
string or null
consigneeId
string or null
(Connection.jsonld-metadata.write_shipment.write (object or null))
description
string or null
marksAndNums
string or null
attributes
Array of strings or null
subscribeTracking
boolean
subscriptionId
string or null
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
houseBillOfLading
string or null
masterBillOfLading
string or null
draft
boolean
forwarderErpEntity
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
originalEta
string or null <date-time>
originalEtd
string or null <date-time>
eta
string or null <date-time>
etd
string or null <date-time>
ata
string or null <date-time>
atd
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))

Responses

Request samples

Content type
{
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

Retrieves a Shipment resource.

Retrieves a Shipment resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

Replaces the Shipment resource.

When updating a Shipment with relation to ShippingUnit and ShippingUnitLineItem, Hubble will try to automatically fulfill the SalesOrder by the relation of newly created ShippingUnitLineItem->SalesOrderLineItem.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Shipment resource

shipmentNumber
string or null
required
(Company.jsonld-metadata.write_shipment.write (object or null))

Many Shipment have One Company.

(Warehouse.jsonld-metadata.write_shipment.write (object or null))

Many SalesOrders have One Location/Warehouse.

(Connection.jsonld-metadata.write_shipment.write (object or null))

Many SalesOrders have One Location/Warehouse.

Array of objects (ShippingUnit.jsonld-metadata.write_shipment.write)

One Shipment has Many ShippingUnit.

Array of objects (ShipmentAttribute.jsonld-metadata.write_shipment.write)

One Shipment has Many ShipmentAttribute.

Array of objects (ShipmentLeg.jsonld-metadata.write_shipment.write)

One Shipment has Many ShipmentLegs.

(ShipmentLog.jsonld-metadata.write_shipment.write (object or null))

One Shipment has One ShipmentLog.

(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(Carrier.jsonld-metadata.write_shipment.write (object or null))

Many Shipment have One Carrier.

vehicle
string or null
voyage
string or null
total
integer or null
totalWeight
integer or null
originalEstimatedTimeOfArrival
string or null <date-time>
originalEstimatedTimeOfDeparture
string or null <date-time>
estimatedTimeOfArrival
string or null <date-time>
estimatedTimeOfDeparture
string or null <date-time>
actualTimeOfArrival
string or null <date-time>
actualTimeOfDeparture
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
comment
string or null
externalData
string or null
containerNumber
string or null
Array of objects (SalesOrder.jsonld-metadata.write_shipment.write)

Many Shipments have Many SalesOrders.

extractStatus
string or null
commentDelayReasonDeparture
string or null
commentDelayReasonArrival
string or null
completedAt
string or null <date-time>
(Connection.jsonld-metadata.write_shipment.write (object or null))
(Connection.jsonld-metadata.write_shipment.write (object or null))
(Connection.jsonld-metadata.write_shipment.write (object or null))
destinationAgentReference
string or null
customsReference
string or null
subscriptionStatus
string or null
(Status.jsonld-metadata.write_shipment.write (object or null))
(Status.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
controllingCustomer
string or null
consigneeId
string or null
(Connection.jsonld-metadata.write_shipment.write (object or null))
description
string or null
marksAndNums
string or null
attributes
Array of strings or null
subscribeTracking
boolean
subscriptionId
string or null
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))
houseBillOfLading
string or null
masterBillOfLading
string or null
draft
boolean
forwarderErpEntity
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
originalEta
string or null <date-time>
originalEtd
string or null <date-time>
eta
string or null <date-time>
etd
string or null <date-time>
ata
string or null <date-time>
atd
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_shipment.write (object or null))

Responses

Request samples

Content type
{
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

Removes the Shipment resource.

Removes the Shipment resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the Shipment resource.

When updating a Shipment with relation to ShippingUnit and ShippingUnitLineItem, Hubble will try to automatically fulfill the SalesOrder by the relation of newly created ShippingUnitLineItem->SalesOrderLineItem.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Shipment resource

shipmentNumber
string or null
required
(Company-metadata.write_shipment.write (object or null))

Many Shipment have One Company.

(Warehouse-metadata.write_shipment.write (object or null))

Many SalesOrders have One Location/Warehouse.

(Connection-metadata.write_shipment.write (object or null))

Many SalesOrders have One Location/Warehouse.

Array of objects (ShippingUnit-metadata.write_shipment.write)

One Shipment has Many ShippingUnit.

Array of objects (ShipmentAttribute-metadata.write_shipment.write)

One Shipment has Many ShipmentAttribute.

Array of objects (ShipmentLeg-metadata.write_shipment.write)

One Shipment has Many ShipmentLegs.

(ShipmentLog-metadata.write_shipment.write (object or null))

One Shipment has One ShipmentLog.

(ReferenceCode-metadata.write_shipment.write (object or null))
(Carrier-metadata.write_shipment.write (object or null))

Many Shipment have One Carrier.

vehicle
string or null
voyage
string or null
total
integer or null
totalWeight
integer or null
originalEstimatedTimeOfArrival
string or null <date-time>
originalEstimatedTimeOfDeparture
string or null <date-time>
estimatedTimeOfArrival
string or null <date-time>
estimatedTimeOfDeparture
string or null <date-time>
actualTimeOfArrival
string or null <date-time>
actualTimeOfDeparture
string or null <date-time>
(ReferenceCode-metadata.write_shipment.write (object or null))
(ReferenceCode-metadata.write_shipment.write (object or null))
comment
string or null
externalData
string or null
containerNumber
string or null
Array of objects (SalesOrder-metadata.write_shipment.write)

Many Shipments have Many SalesOrders.

extractStatus
string or null
commentDelayReasonDeparture
string or null
commentDelayReasonArrival
string or null
completedAt
string or null <date-time>
(Connection-metadata.write_shipment.write (object or null))
(Connection-metadata.write_shipment.write (object or null))
(Connection-metadata.write_shipment.write (object or null))
destinationAgentReference
string or null
customsReference
string or null
subscriptionStatus
string or null
(Status-metadata.write_shipment.write (object or null))
(Status-metadata.write_shipment.write (object or null))
(ReferenceCode-metadata.write_shipment.write (object or null))
(ReferenceCode-metadata.write_shipment.write (object or null))
controllingCustomer
string or null
consigneeId
string or null
(Connection-metadata.write_shipment.write (object or null))
description
string or null
marksAndNums
string or null
attributes
Array of strings or null
subscribeTracking
boolean
subscriptionId
string or null
(ReferenceCode-metadata.write_shipment.write (object or null))
(ReferenceCode-metadata.write_shipment.write (object or null))
houseBillOfLading
string or null
masterBillOfLading
string or null
draft
boolean
forwarderErpEntity
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
originalEta
string or null <date-time>
originalEtd
string or null <date-time>
eta
string or null <date-time>
etd
string or null <date-time>
ata
string or null <date-time>
atd
string or null <date-time>
(ReferenceCode-metadata.write_shipment.write (object or null))

Responses

Request samples

Content type
application/merge-patch+json
{
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipmentNumber": "string",
  • "company": {
    },
  • "shipFrom": {
    },
  • "shipFromSupplier": {
    },
  • "shippingUnits": [
    ],
  • "shipmentAttributes": [
    ],
  • "shipmentLegs": [
    ],
  • "shipmentLog": {
    },
  • "mainTransportType": {
    },
  • "carrier": {
    },
  • "vehicle": "string",
  • "voyage": "string",
  • "total": 0,
  • "totalWeight": 0,
  • "originalEstimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "originalEstimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfArrival": "2019-08-24T14:15:22Z",
  • "estimatedTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "actualTimeOfArrival": "2019-08-24T14:15:22Z",
  • "actualTimeOfDeparture": "2019-08-24T14:15:22Z",
  • "delayReasonDeparture": {
    },
  • "delayReasonArrival": {
    },
  • "comment": "string",
  • "externalData": "string",
  • "containerNumber": "string",
  • "salesOrders": [
    ],
  • "extractStatus": "string",
  • "commentDelayReasonDeparture": "string",
  • "commentDelayReasonArrival": "string",
  • "completedAt": "2019-08-24T14:15:22Z",
  • "billingTo": {
    },
  • "originForwarder": {
    },
  • "destinationForwarder": {
    },
  • "destinationAgentReference": "string",
  • "customsReference": "string",
  • "subscriptionStatus": "string",
  • "documentStatus": {
    },
  • "releaseStatus": {
    },
  • "contractType": {
    },
  • "houseBillOfLadingIncoterm": {
    },
  • "controllingCustomer": "string",
  • "consigneeId": "string",
  • "notify": {
    },
  • "description": "string",
  • "marksAndNums": "string",
  • "attributes": [
    ],
  • "subscribeTracking": true,
  • "subscriptionId": "string",
  • "portOfLoading": {
    },
  • "portOfDischarge": {
    },
  • "houseBillOfLading": "string",
  • "masterBillOfLading": "string",
  • "draft": true,
  • "forwarderErpEntity": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "originalEta": "2019-08-24T14:15:22Z",
  • "originalEtd": "2019-08-24T14:15:22Z",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "ata": "2019-08-24T14:15:22Z",
  • "atd": "2019-08-24T14:15:22Z",
  • "hblIncoterm": {
    }
}

ShippingUnitLineItem

Retrieves the collection of ShippingUnitLineItem resources.

Retrieves the collection of ShippingUnitLineItem resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

variant.id
integer
variant.id[]
Array of integers
variant.name
string
variant.sku
string
salesOrderLineItem.salesOrder.orderNumber
string
salesOrderLineItem.salesOrder.fulfillmentStatus
string
salesOrderLineItem.salesOrder.fulfillmentStatus[]
Array of strings
salesOrderLineItem.salesOrder.orderOrigin
string
salesOrderLineItem.salesOrder.orderOrigin[]
Array of strings
salesOrderLineItem.salesOrder.shipFrom.name
string
salesOrderLineItem.salesOrder.warehouseLocation.name
string
salesOrderLineItem.salesOrder.warehouseLocation.name[]
Array of strings
salesOrderLineItem.salesOrder.warehouseLocation.code
string
salesOrderLineItem.salesOrder.warehouseLocation.code[]
Array of strings
salesOrderLineItem.salesOrder.shipTo.name
string
salesOrderLineItem.salesOrder.fulfillmentStatus.code
string
salesOrderLineItem.salesOrder.fulfillmentStatus.code[]
Array of strings
salesOrderLineItem.salesOrder.mainTransportType.code
string
salesOrderLineItem.salesOrder.mainTransportType.code[]
Array of strings
shippingUnit.company.id
integer
shippingUnit.company.id[]
Array of integers
lotNumber
string
shippingUnit.shippingTrackingNumber
string
shippingUnit.shippingUnitNumber
string
shippingUnit.shipment.shipmentNumber
string
shippingUnit.shippingUnitStatus.code
string
shippingUnit.shippingUnitStatus.code[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
salesOrderLineItem.salesOrder.shippedAt[before]
string
salesOrderLineItem.salesOrder.shippedAt[strictly_before]
string
salesOrderLineItem.salesOrder.shippedAt[after]
string
salesOrderLineItem.salesOrder.shippedAt[strictly_after]
string
salesOrderLineItem.salesOrder.paidAt[before]
string
salesOrderLineItem.salesOrder.paidAt[strictly_before]
string
salesOrderLineItem.salesOrder.paidAt[after]
string
salesOrderLineItem.salesOrder.paidAt[strictly_after]
string
salesOrderLineItem.salesOrder.dueAt[before]
string
salesOrderLineItem.salesOrder.dueAt[strictly_before]
string
salesOrderLineItem.salesOrder.dueAt[after]
string
salesOrderLineItem.salesOrder.dueAt[strictly_after]
string
expiryDate[before]
string
expiryDate[strictly_before]
string
expiryDate[after]
string
expiryDate[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a ShippingUnitLineItem resource.

Creates a ShippingUnitLineItem resource.

Authorizations:
apiKey
Request Body schema:

The new ShippingUnitLineItem resource

(ShippingUnit.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
(Variant.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
quantity
integer
(ReferenceCode.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
totalWeight
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
totalVolume
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
numberOfBoxes
integer
(Connection.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
expiryDate
string or null <date-time>
lotNumber
string or null
ownerCode
string or null
(SalesOrderLineItem.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
(Booking.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
(BookingLineItem.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
weight
number or null
volume
number or null

Responses

Request samples

Content type
{
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

Retrieves a ShippingUnitLineItem resource.

Retrieves a ShippingUnitLineItem resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

Replaces the ShippingUnitLineItem resource.

Replaces the ShippingUnitLineItem resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated ShippingUnitLineItem resource

(ShippingUnit.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
(Variant.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
quantity
integer
(ReferenceCode.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
totalWeight
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
totalVolume
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
numberOfBoxes
integer
(Connection.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
expiryDate
string or null <date-time>
lotNumber
string or null
ownerCode
string or null
(SalesOrderLineItem.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
(Booking.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
(BookingLineItem.jsonld-metadata.write_shipping_unit_line_item.write (object or null))
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
weight
number or null
volume
number or null

Responses

Request samples

Content type
{
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

Removes the ShippingUnitLineItem resource.

Removes the ShippingUnitLineItem resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the ShippingUnitLineItem resource.

Updates the ShippingUnitLineItem resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated ShippingUnitLineItem resource

(ShippingUnit-metadata.write_shipping_unit_line_item.write (object or null))
(Variant-metadata.write_shipping_unit_line_item.write (object or null))
quantity
integer
(ReferenceCode-metadata.write_shipping_unit_line_item.write (object or null))
totalWeight
number or null
(ReferenceCode-metadata.write_shipping_unit_line_item.write (object or null))
totalVolume
number or null
(ReferenceCode-metadata.write_shipping_unit_line_item.write (object or null))
numberOfBoxes
integer
(Connection-metadata.write_shipping_unit_line_item.write (object or null))
expiryDate
string or null <date-time>
lotNumber
string or null
ownerCode
string or null
(SalesOrderLineItem-metadata.write_shipping_unit_line_item.write (object or null))
(Booking-metadata.write_shipping_unit_line_item.write (object or null))
(BookingLineItem-metadata.write_shipping_unit_line_item.write (object or null))
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>
weight
number or null
volume
number or null

Responses

Request samples

Content type
application/merge-patch+json
{
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shippingUnit": {
    },
  • "variant": {
    },
  • "quantity": 0,
  • "quantityUom": {
    },
  • "totalWeight": 0,
  • "weightUom": {
    },
  • "totalVolume": 0,
  • "volumeUom": {
    },
  • "numberOfBoxes": 0,
  • "supplier": {
    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "salesOrderLineItem": {
    },
  • "booking": {
    },
  • "bookingLineItem": {
    },
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "weight": 0,
  • "volume": 0
}

ShippingUnit

Retrieves the collection of ShippingUnit resources.

Retrieves the collection of ShippingUnit resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

shippingTrackingNumber
string
shippingUnitNumber
string
shipment.shipmentNumber
string
company.id
integer
company.id[]
Array of integers
shippingUnitStatus
string
shippingUnitStatus[]
Array of strings
shippingUnitStatus.code
string
shippingUnitStatus.code[]
Array of strings
shipTo.name
string
salesOrder.orderNumber
string
shipment.houseBillOfLading
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
completedAt[before]
string
completedAt[strictly_before]
string
completedAt[after]
string
completedAt[strictly_after]
string
order[id]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[shippingUnitNumber]
string
Enum: "asc" "desc"
json_contains_attributes
string
Example: json_contains_attributes=urlsafebase64encode('{"needle": {"code": "lorem ipsum"}, "path": "$.nestedPath"}')

URL-safe base64 encoded JSON string with required "needle" key and optional "path" key.

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a ShippingUnit resource.

Creates a ShippingUnit resource.

Authorizations:
apiKey
Request Body schema:

The new ShippingUnit resource

(Shipment.jsonld-metadata.write_shipping_unit.write (object or null))

Many ShipmentAttribute may have One Shipment.

shippingUnitNumber
string or null
shippingTrackingNumber
string or null
shippingTrackingUrl
string or null
Array of objects (ShippingUnitLineItem.jsonld-metadata.write_shipping_unit.write)
Array of objects (ShippingUnitAttribute.jsonld-metadata.write_shipping_unit.write)
Array of objects (ShippingUnitEvent.jsonld-metadata.write_shipping_unit.write)
(Connection.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
weight
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
volume
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
height
number or null
width
number or null
length
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
required
(Company.jsonld-metadata.write_shipping_unit.write (object or null))
completedAt
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))

Many ShippingUnits have One shippingUnitStatus

containerAvailabilityDate
string or null <date-time>
pickUpDate
string or null <date-time>
returnDate
string or null <date-time>
maxReturnDate
string or null <date-time>
deliveryDateTime
string or null <date-time>
deliveryLocation
string or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
attributes
Array of strings or null
(SalesOrder.jsonld-metadata.write_shipping_unit.write (object or null))

Many ShippingUnits have One SalesOrder @ ORM\ManyToOne(targetEntity="SalesOrder") @ ORM\JoinColumn(referencedColumnName="id", nullable=true, onDelete="SET NULL")

(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
sealNumber
string or null
referenceOrderNumber
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a ShippingUnit resource.

Retrieves a ShippingUnit resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the ShippingUnit resource.

Replaces the ShippingUnit resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated ShippingUnit resource

(Shipment.jsonld-metadata.write_shipping_unit.write (object or null))

Many ShipmentAttribute may have One Shipment.

shippingUnitNumber
string or null
shippingTrackingNumber
string or null
shippingTrackingUrl
string or null
Array of objects (ShippingUnitLineItem.jsonld-metadata.write_shipping_unit.write)
Array of objects (ShippingUnitAttribute.jsonld-metadata.write_shipping_unit.write)
Array of objects (ShippingUnitEvent.jsonld-metadata.write_shipping_unit.write)
(Connection.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
weight
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
volume
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
height
number or null
width
number or null
length
number or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
required
(Company.jsonld-metadata.write_shipping_unit.write (object or null))
completedAt
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))

Many ShippingUnits have One shippingUnitStatus

containerAvailabilityDate
string or null <date-time>
pickUpDate
string or null <date-time>
returnDate
string or null <date-time>
maxReturnDate
string or null <date-time>
deliveryDateTime
string or null <date-time>
deliveryLocation
string or null
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
attributes
Array of strings or null
(SalesOrder.jsonld-metadata.write_shipping_unit.write (object or null))

Many ShippingUnits have One SalesOrder @ ORM\ManyToOne(targetEntity="SalesOrder") @ ORM\JoinColumn(referencedColumnName="id", nullable=true, onDelete="SET NULL")

(ReferenceCode.jsonld-metadata.write_shipping_unit.write (object or null))
sealNumber
string or null
referenceOrderNumber
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the ShippingUnit resource.

Removes the ShippingUnit resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the ShippingUnit resource.

Updates the ShippingUnit resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated ShippingUnit resource

(Shipment-metadata.write_shipping_unit.write (object or null))

Many ShipmentAttribute may have One Shipment.

shippingUnitNumber
string or null
shippingTrackingNumber
string or null
shippingTrackingUrl
string or null
Array of objects (ShippingUnitLineItem-metadata.write_shipping_unit.write)
Array of objects (ShippingUnitAttribute-metadata.write_shipping_unit.write)
Array of objects (ShippingUnitEvent-metadata.write_shipping_unit.write)
(Connection-metadata.write_shipping_unit.write (object or null))
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
weight
number or null
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
volume
number or null
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
height
number or null
width
number or null
length
number or null
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
required
(Company-metadata.write_shipping_unit.write (object or null))
completedAt
string or null <date-time>
(ReferenceCode-metadata.write_shipping_unit.write (object or null))

Many ShippingUnits have One shippingUnitStatus

containerAvailabilityDate
string or null <date-time>
pickUpDate
string or null <date-time>
returnDate
string or null <date-time>
maxReturnDate
string or null <date-time>
deliveryDateTime
string or null <date-time>
deliveryLocation
string or null
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
(ReferenceCode-metadata.write_shipping_unit.write (object or null))
attributes
Array of strings or null
(SalesOrder-metadata.write_shipping_unit.write (object or null))

Many ShippingUnits have One SalesOrder @ ORM\ManyToOne(targetEntity="SalesOrder") @ ORM\JoinColumn(referencedColumnName="id", nullable=true, onDelete="SET NULL")

(ReferenceCode-metadata.write_shipping_unit.write (object or null))
sealNumber
string or null
referenceOrderNumber
string or null
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "shipment": {
    },
  • "shippingUnitNumber": "string",
  • "shippingTrackingNumber": "string",
  • "shippingTrackingUrl": "string",
  • "shippingUnitLineItems": [
    ],
  • "shippingUnitAttributes": [
    ],
  • "shippingUnitEvents": [
    ],
  • "shipTo": {
    },
  • "shippingUnitType": {
    },
  • "shippingUnitSize": {
    },
  • "weight": 0,
  • "weightUom": {
    },
  • "volume": 0,
  • "volumeUom": {
    },
  • "height": 0,
  • "width": 0,
  • "length": 0,
  • "dimensionUom": {
    },
  • "company": {
    },
  • "completedAt": "2019-08-24T14:15:22Z",
  • "shippingUnitStatus": {
    },
  • "containerAvailabilityDate": "2019-08-24T14:15:22Z",
  • "pickUpDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "maxReturnDate": "2019-08-24T14:15:22Z",
  • "deliveryDateTime": "2019-08-24T14:15:22Z",
  • "deliveryLocation": "string",
  • "deliveryType": {
    },
  • "deliveryAgent": {
    },
  • "deliveryIssueType": {
    },
  • "attributes": [
    ],
  • "salesOrder": {
    },
  • "loadingType": {
    },
  • "sealNumber": "string",
  • "referenceOrderNumber": "string",
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

StockMovement

Retrieves the collection of StockMovement resources.

Retrieves the collection of StockMovement resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

company
string
company[]
Array of strings
warehouse
string
warehouse[]
Array of strings
variant.id
integer
variant.id[]
Array of integers
variant.name
string
variant.sku
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
movedAt[before]
string
movedAt[strictly_before]
string
movedAt[after]
string
movedAt[strictly_after]
string
quantity[between]
string
quantity[gt]
string
quantity[gte]
string
quantity[lt]
string
quantity[lte]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a StockMovement resource.

Creates a StockMovement resource.

Authorizations:
apiKey
Request Body schema:

The new StockMovement resource

fromExpiryDate
string or null <date-time>
(StockPosition.jsonld-metadata.write_stock_movement.write (object or null))
fromLotNumber
string or null
fromOwnerCode
string or null
(StockPosition.jsonld-metadata.write_stock_movement.write (object or null))
toExpiryDate
string or null <date-time>
toLotNumber
string or null
toOwnerCode
string or null
quantity
number
movedAt
string or null <date-time>
(ReferenceCode.jsonld-metadata.write_stock_movement.write (object or null))
(StockMovementOrigin.jsonld-metadata.write_stock_movement.write (object or null))
comment
string or null
(Company.jsonld-metadata.write_stock_movement.write (object or null))
(Warehouse.jsonld-metadata.write_stock_movement.write (object or null))
(Variant.jsonld-metadata.write_stock_movement.write (object or null))
processed
boolean
updatedBy
string or null <iri-reference>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "fromExpiryDate": "2019-08-24T14:15:22Z",
  • "fromPosition": { },
  • "fromLotNumber": "string",
  • "fromOwnerCode": "string",
  • "toPosition": { },
  • "toExpiryDate": "2019-08-24T14:15:22Z",
  • "toLotNumber": "string",
  • "toOwnerCode": "string",
  • "quantity": 0,
  • "movedAt": "2019-08-24T14:15:22Z",
  • "reasonCode": {
    },
  • "origin": { },
  • "comment": "string",
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "processed": true,
  • "updatedBy": "../словник",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "fromExpiryDate": "2019-08-24T14:15:22Z",
  • "fromPosition": {
    },
  • "fromLotNumber": "string",
  • "fromOwnerCode": "string",
  • "toPosition": {
    },
  • "toExpiryDate": "2019-08-24T14:15:22Z",
  • "toLotNumber": "string",
  • "toOwnerCode": "string",
  • "quantity": 0,
  • "movedAt": "2019-08-24T14:15:22Z",
  • "reasonCode": {
    },
  • "origin": {
    },
  • "comment": "string",
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "processed": true,
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a StockMovement resource.

Retrieves a StockMovement resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "fromExpiryDate": "2019-08-24T14:15:22Z",
  • "fromPosition": {
    },
  • "fromLotNumber": "string",
  • "fromOwnerCode": "string",
  • "toPosition": {
    },
  • "toExpiryDate": "2019-08-24T14:15:22Z",
  • "toLotNumber": "string",
  • "toOwnerCode": "string",
  • "quantity": 0,
  • "movedAt": "2019-08-24T14:15:22Z",
  • "reasonCode": {
    },
  • "origin": {
    },
  • "comment": "string",
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "processed": true,
  • "createdBy": "../словник",
  • "updatedBy": "../словник",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

StockTransactionLine

Retrieves the collection of StockTransactionLine resources.

Retrieves the collection of StockTransactionLine resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

fromCompany
string
fromCompany[]
Array of strings
fromCompany.id
integer
fromCompany.id[]
Array of integers
warehouse
string
warehouse[]
Array of strings
warehouse.name
string
warehouse.name[]
Array of strings
warehouse.code
string
warehouse.code[]
Array of strings
transactionType
string
referenceNumber
string
variant.id
integer
variant.id[]
Array of integers
variant.name
string
variant.sku
string
stock.id
integer
stock.id[]
Array of integers
stock.lotNumber
string
stock.ownerCode
string
entityType
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
movedAt[before]
string
movedAt[strictly_before]
string
movedAt[after]
string
movedAt[strictly_after]
string
stock.expiryDate[before]
string
stock.expiryDate[strictly_before]
string
stock.expiryDate[after]
string
stock.expiryDate[strictly_after]
string
exists[stock.expiryDate]
boolean
quantity[between]
string
quantity[gt]
string
quantity[gte]
string
quantity[lt]
string
quantity[lte]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a StockTransactionLine resource.

Retrieves a StockTransactionLine resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "stock": {
    },
  • "transactionType": "string",
  • "transactionTypeString": "string",
  • "referenceNumber": "string",
  • "referenceId": "string",
  • "referenceType": "string",
  • "quantity": 0,
  • "fromCompany": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "user": {
    },
  • "movedAt": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "entityType": "string",
  • "reasonCode": {
    },
  • "linkedStockTransactionLine": { },
  • "processed": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Stock

Retrieves the collection of Stock resources.

Retrieves the collection of Stock resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

company
string
company[]
Array of strings
company.id
integer
company.id[]
Array of integers
warehouse
string
warehouse[]
Array of strings
warehouse.name
string
warehouse.name[]
Array of strings
warehouse.code
string
warehouse.code[]
Array of strings
variant.id
integer
variant.id[]
Array of integers
variant.name
string
variant.sku
string
lotNumber
string
ownerCode
string
ownerCode[]
Array of strings
expiryDate
string
expiryDate[before]
string
expiryDate[strictly_before]
string
expiryDate[after]
string
expiryDate[strictly_after]
string
exists[expiryDate]
boolean
available
number
available[]
Array of numbers
incoming
number
incoming[]
Array of numbers
allocated
number
allocated[]
Array of numbers
locked
number
locked[]
Array of numbers
available[between]
string
available[gt]
string
available[gte]
string
available[lt]
string
available[lte]
string
incoming[between]
string
incoming[gt]
string
incoming[gte]
string
incoming[lt]
string
incoming[lte]
string
allocated[between]
string
allocated[gt]
string
allocated[gte]
string
allocated[lt]
string
allocated[lte]
string
locked[between]
string
locked[gt]
string
locked[gte]
string
locked[lt]
string
locked[lte]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Retrieves a Stock resource.

Retrieves a Stock resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "stockOnHand": 0,
  • "available": 0,
  • "incoming": 0,
  • "allocated": 0,
  • "locked": 0,
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the Stock resource.

Replaces the Stock resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Stock resource

expiryDate
string or null <date-time>
lotNumber
string or null
ownerCode
string or null
stockOnHand
number
available
number
incoming
number
allocated
number
locked
number
(Company.jsonld-metadata.write_stock.write (object or null))

Many Stock have one Company

(Warehouse.jsonld-metadata.write_stock.write (object or null))

Many Stock have one Warehouse

(Variant.jsonld-metadata.write_stock.write (object or null))

Many Stock have one Variant

updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "stockOnHand": 0,
  • "available": 0,
  • "incoming": 0,
  • "allocated": 0,
  • "locked": 0,
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "stockOnHand": 0,
  • "available": 0,
  • "incoming": 0,
  • "allocated": 0,
  • "locked": 0,
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the Stock resource.

Removes the Stock resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the Stock resource.

Updates the Stock resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Stock resource

expiryDate
string or null <date-time>
lotNumber
string or null
ownerCode
string or null
stockOnHand
number
available
number
incoming
number
allocated
number
locked
number
(Company-metadata.write_stock.write (object or null))

Many Stock have one Company

(Warehouse-metadata.write_stock.write (object or null))

Many Stock have one Warehouse

(Variant-metadata.write_stock.write (object or null))

Many Stock have one Variant

updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "stockOnHand": 0,
  • "available": 0,
  • "incoming": 0,
  • "allocated": 0,
  • "locked": 0,
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "lotNumber": "string",
  • "ownerCode": "string",
  • "stockOnHand": 0,
  • "available": 0,
  • "incoming": 0,
  • "allocated": 0,
  • "locked": 0,
  • "company": {
    },
  • "warehouse": {
    },
  • "variant": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Variant

Retrieves the collection of Variant resources.

Retrieves the collection of Variant resources.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

pagination
boolean

Enable or disable pagination

ean
string
sku
string
name
string
company.id
integer
company.id[]
Array of integers

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Variant resource.

Creates a Variant resource.

Authorizations:
apiKey
Request Body schema:

The new Variant resource

name
required
string
pictureUrl
string or null
translatedName
string or null
description1
string or null
translatedDescription1
string or null
description2
string or null
translatedDescription2
string or null
active
boolean
Default: true
certificate
boolean
expirable
boolean
taxable
boolean
required
(Company.jsonld-metadata.write_variant.write (object or null))
Array of objects (Warehouse.jsonld-metadata.write_variant.write)

Many Variants have Many Locations / warehouses.

hscode
string or null
sku
required
string or null
ean
string or null
upc
string or null

The Universal Product Code

weightUnit
string or null
grossWeight
number or null
netWeight
number or null
metricUnit
string or null
height
number or null
length
number or null
width
number or null
cbm
number or null
boxUnit
number
quantityPerBox
integer or null
grossWeightBox
number
currency
buyPrice
number or null
retailPrice
number or null
wholesalePrice
number or null
shopifySku
string or null
(Connection.jsonld-metadata.write_variant.write (object or null))

Many Variants have One Supplier.

minStock
number or null
maxStock
number or null
orderMultiple
integer or null
minimumOrderQuantity
integer or null
boxesPerLayer
integer or null
layersPerPallet
integer or null
externalId
string or null
fragile
boolean
wmsEdiGeneratedAt
string or null <date-time>
wmsEdiSession
string or null
unitOfMeasure
string or null
countryOfOrigin
string or null
Array of objects (VariantAttribute.jsonld-metadata.write_variant.write)
(ReferenceCode.jsonld-metadata.write_variant.write (object or null))
expiryManagement
boolean
supplierSku
string or null
expirySafetyInDays
integer
brand
string or null
size
string or null
color
string or null
reference
string or null
family
string or null
pcb
string or null
attributes
Array of strings or null
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "stocks": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Retrieves a Variant resource.

Retrieves a Variant resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "stocks": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replaces the Variant resource.

Replaces the Variant resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema:

The updated Variant resource

name
required
string
pictureUrl
string or null
translatedName
string or null
description1
string or null
translatedDescription1
string or null
description2
string or null
translatedDescription2
string or null
active
boolean
Default: true
certificate
boolean
expirable
boolean
taxable
boolean
required
(Company.jsonld-metadata.write_variant.write (object or null))
Array of objects (Warehouse.jsonld-metadata.write_variant.write)

Many Variants have Many Locations / warehouses.

hscode
string or null
sku
required
string or null
ean
string or null
upc
string or null

The Universal Product Code

weightUnit
string or null
grossWeight
number or null
netWeight
number or null
metricUnit
string or null
height
number or null
length
number or null
width
number or null
cbm
number or null
boxUnit
number
quantityPerBox
integer or null
grossWeightBox
number
currency
buyPrice
number or null
retailPrice
number or null
wholesalePrice
number or null
shopifySku
string or null
(Connection.jsonld-metadata.write_variant.write (object or null))

Many Variants have One Supplier.

minStock
number or null
maxStock
number or null
orderMultiple
integer or null
minimumOrderQuantity
integer or null
boxesPerLayer
integer or null
layersPerPallet
integer or null
externalId
string or null
fragile
boolean
wmsEdiGeneratedAt
string or null <date-time>
wmsEdiSession
string or null
unitOfMeasure
string or null
countryOfOrigin
string or null
Array of objects (VariantAttribute.jsonld-metadata.write_variant.write)
(ReferenceCode.jsonld-metadata.write_variant.write (object or null))
expiryManagement
boolean
supplierSku
string or null
expirySafetyInDays
integer
brand
string or null
size
string or null
color
string or null
reference
string or null
family
string or null
pcb
string or null
attributes
Array of strings or null
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "stocks": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Removes the Variant resource.

Removes the Variant resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Responses

Updates the Variant resource.

Updates the Variant resource.

Authorizations:
apiKey
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

The updated Variant resource

name
required
string
pictureUrl
string or null
translatedName
string or null
description1
string or null
translatedDescription1
string or null
description2
string or null
translatedDescription2
string or null
active
boolean
Default: true
certificate
boolean
expirable
boolean
taxable
boolean
required
(Company-metadata.write_variant.write (object or null))
Array of objects (Warehouse-metadata.write_variant.write)

Many Variants have Many Locations / warehouses.

hscode
string or null
sku
required
string or null
ean
string or null
upc
string or null

The Universal Product Code

weightUnit
string or null
grossWeight
number or null
netWeight
number or null
metricUnit
string or null
height
number or null
length
number or null
width
number or null
cbm
number or null
boxUnit
number
quantityPerBox
integer or null
grossWeightBox
number
currency
buyPrice
number or null
retailPrice
number or null
wholesalePrice
number or null
shopifySku
string or null
(Connection-metadata.write_variant.write (object or null))

Many Variants have One Supplier.

minStock
number or null
maxStock
number or null
orderMultiple
integer or null
minimumOrderQuantity
integer or null
boxesPerLayer
integer or null
layersPerPallet
integer or null
externalId
string or null
fragile
boolean
wmsEdiGeneratedAt
string or null <date-time>
wmsEdiSession
string or null
unitOfMeasure
string or null
countryOfOrigin
string or null
Array of objects (VariantAttribute-metadata.write_variant.write)
(ReferenceCode-metadata.write_variant.write (object or null))
expiryManagement
boolean
supplierSku
string or null
expirySafetyInDays
integer
brand
string or null
size
string or null
color
string or null
reference
string or null
family
string or null
pcb
string or null
attributes
Array of strings or null
updatedAt
string <date-time>

Responses

Request samples

Content type
application/merge-patch+json
{
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": 0,
  • "name": "string",
  • "pictureUrl": "string",
  • "translatedName": "string",
  • "description1": "string",
  • "translatedDescription1": "string",
  • "description2": "string",
  • "translatedDescription2": "string",
  • "active": true,
  • "certificate": true,
  • "expirable": true,
  • "taxable": true,
  • "company": {
    },
  • "warehouses": [
    ],
  • "hscode": "string",
  • "sku": "string",
  • "ean": "string",
  • "upc": "string",
  • "weightUnit": "string",
  • "grossWeight": 0,
  • "netWeight": 0,
  • "metricUnit": "string",
  • "height": 0,
  • "length": 0,
  • "width": 0,
  • "cbm": 0,
  • "boxUnit": 0,
  • "quantityPerBox": 0,
  • "grossWeightBox": 0,
  • "currency": "string",
  • "buyPrice": 0,
  • "retailPrice": 0,
  • "wholesalePrice": 0,
  • "shopifySku": "string",
  • "supplier": {
    },
  • "minStock": 0,
  • "maxStock": 0,
  • "orderMultiple": 0,
  • "minimumOrderQuantity": 0,
  • "boxesPerLayer": 0,
  • "layersPerPallet": 0,
  • "externalId": "string",
  • "fragile": true,
  • "wmsEdiGeneratedAt": "2019-08-24T14:15:22Z",
  • "wmsEdiSession": "string",
  • "unitOfMeasure": "string",
  • "countryOfOrigin": "string",
  • "variantAttributes": [
    ],
  • "stocks": [
    ],
  • "lotManagement": {
    },
  • "expiryManagement": true,
  • "supplierSku": "string",
  • "expirySafetyInDays": 0,
  • "brand": "string",
  • "size": "string",
  • "color": "string",
  • "reference": "string",
  • "family": "string",
  • "pcb": "string",
  • "attributes": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}