Skip to content

Planning shipment

POST
/rest/shipping/shipments/{id}/planning
curl --request POST \
--url https://api.shypr.app/rest/shipping/shipments/example/planning \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <X-API-KEY>' \
--data '{ "shipmentIri": "example", "collectionDate": "2026-04-15T12:00:00Z", "collectionTimeRange": { "start": "2026-04-15T12:00:00Z", "end": "2026-04-15T12:00:00Z" }, "orderNumber": "example" }'

Creates a Shipment resource.

id
required
string

Shipment identifier

The new Shipment resource

object
shipmentIri
required
string
collectionDate
required
string format: date-time
collectionTimeRange
required
object
start
string format: date-time
end
string format: date-time
diffYears
Array<integer>
orderNumber
required
string

Example generated

{
"shipmentIri": "example",
"collectionDate": "2026-04-15T12:00:00Z",
"collectionTimeRange": {
"start": "2026-04-15T12:00:00Z",
"end": "2026-04-15T12:00:00Z"
},
"orderNumber": "example"
}

Shipment resource created

object
salesOrder
string format: iri-reference
pickupFrom

The address of the workspace as it was on the day of the shipment.

object
countryName
string
countryISOAlpha3
string
name
string
street
string
city
string
zip
string
streetNo
string | null
state
string | null
attention
string | null
fullAddress
string
lines

The lines of the address on a PDF: the street, the zip with the city and the state, the country.

Array<string>
country
object
name
string
alpha2Code
string
alpha3Code
string
region
string
taxRate
number
europeanRegion
boolean
europeanUnion
boolean
shipTo

The ship-to address of the sales order as it was on the day of the shipment.

object
countryName
string
countryISOAlpha3
string
name
string
street
string
city
string
zip
string
streetNo
string | null
state
string | null
attention
string | null
fullAddress
string
lines

The lines of the address on a PDF: the street, the zip with the city and the state, the country.

Array<string>
country
object
name
string
alpha2Code
string
alpha3Code
string
region
string
taxRate
number
europeanRegion
boolean
europeanUnion
boolean
estimatedTimeArrival
string | null format: date-time
estimatedTimeCollection
string | null format: date-time
requestedStartTimeCollection
string | null format: date-time
requestedEndTimeCollection
string | null format: date-time
deliveredAt
string | null format: date-time
subTotal
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
vatTotal
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
grandTotal
object
amount

The amount.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
currency

The currency.

object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
context

The context that defines the capability of this Money.

object
step

Returns the step used by this context.

integer
fixedScale

Returns whether this context produces a deterministic scale regardless of the input value.

boolean
minorAmount

Returns the amount of this Money in minor units (cents) for the currency.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart

Returns the fractional part of this decimal number.

object
scale

The scale (number of digits after the decimal point) of this decimal number.

integer
sign
integer
unscaledValue

Returns the unscaled value of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
precision

Returns the number of significant digits in the number.

integer
integralPart

Returns the integral part of this decimal number.

object
bitLength

Returns the number of bits in the minimal two’s-complement representation of this BigInteger, excluding a sign bit.

integer
lowestSetBit

Returns the index of the rightmost (lowest-order) one bit in this BigInteger.

integer | null
even

Returns whether this number is even.

boolean
odd

Returns whether this number is odd.

boolean
sign
integer
one
boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
fractionalPart
object recursive
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
zero

Checks if this number equals zero.

boolean
negative

Checks if this number is strictly negative.

boolean
negativeOrZero

Checks if this number is negative or zero.

boolean
positive

Checks if this number is strictly positive.

boolean
positiveOrZero

Checks if this number is positive or zero.

boolean
monies

This method satisfies the Monetary interface.

Array
sign

Returns the sign of this money.

integer
zero

Returns whether this money has zero value.

boolean
negative

Returns whether this money has a negative value.

boolean
negativeOrZero

Returns whether this money has a negative or zero value.

boolean
positive

Returns whether this money has a positive value.

boolean
positiveOrZero

Returns whether this money has a positive or zero value.

boolean
currency
object
currencyCode

The currency code. For ISO currencies this will be the 3-letter uppercase ISO 4217 currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes.

string
numericCode

The numeric currency code. For ISO currencies this will be the ISO 4217 numeric currency code. For non-ISO currencies no constraints are defined, but the code must be unique across an application and must not conflict with ISO currency codes. Set to null if the currency does not have a numeric code.

integer | null
name

The currency name. For ISO currencies this will be the official English name of the currency. For non-ISO currencies no constraints are defined.

string
defaultFractionDigits

The default number of fraction digits (typical scale) used with this currency. For example, the default number of fraction digits for the Euro is 2, while for the Japanese Yen it is 0. This cannot be a negative number.

integer
currencyType

The type of the currency. For ISO currencies, this indicates whether the currency is currently in use (IsoCurrent) or has been withdrawn (IsoHistorical). For non-ISO currencies defined by the application, the type is Custom.

object
name
string
status
string
Allowed values: "" created planned collected out for delivery in transit delivered cancelled
customsInvoiceUploaded
boolean | null
collectionNumber
string | null
carrier
string
default: selectcourier
Allowed values: selectcourier sendcloud
packinglist
string format: iri-reference
orderNumber
string
carrierName
string
consignmentNumber
string
serviceName
string
serviceId
string
attachments
Array<string>
creator
string format: iri-reference
createdAt
string format: date-time
updatedAt
string | null format: date-time
id

More information

string format: uuid
uid
string

Example

{
"salesOrder": "https://example.com/",
"status": "",
"carrier": "selectcourier",
"packinglist": "https://example.com/",
"attachments": [
"https://example.com/"
],
"creator": "https://example.com/"
}

Invalid input

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

Forbidden

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

An error occurred

Unprocessable entity

object
status
integer
default: 422
violations
Array<object>
object
propertyPath
required

The property path of the violation

string
message
required

The message associated with the violation

string
code

The code of the violation

string
hint

An extra hint to understand the violation

string
payload

The serialized payload of the violation

object
key
additional properties
any
detail
string
type
string
title
string | null
instance
string | null

Example

{
"status": 422
}