Package com.commercetools.api.models.error

Interface GraphQLInvalidItemShippingDetailsError

All Superinterfaces:

GraphQLErrorObject

public interface GraphQLInvalidItemShippingDetailsError
extends GraphQLErrorObject

Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.

When a Cart is frozen, the error can be returned as a failed response to all update actions on Carts and My Carts.

The error is also returned as a failed response to:

• Create Cart and Create Cart in Store requests and Add LineItem, Add CustomLineItem, Set LineItem ShippingDetails, Set CustomLineItem ShippingDetails, Add Shopping List, and Remove LineItem update actions on Carts.
• Create Cart and Create Cart in Store requests, and Add LineItem, Set LineItem ShippingDetails, and Remove LineItem update actions on My Carts.
• Create Cart in BusinessUnit request on Associate Carts.
• Create Order from Cart, Create Order in Store from Cart, Create Order from Quote, and Create Order by Import requests on Orders.
• Create Order from Cart, Create Order in Store from Cart, and Create Order from Quote requests on My Orders.
• Add LineItem, Add CustomLineItem, Set LineItem ShippingDetails, Set CustomLineItem ShippingDetails, Add Shopping List, and Remove LineItem update actions on Order Edits.
• Create Order from Cart in BusinessUnit and Create Order from Quote in BusinessUnit requests on Associate Orders.

Example to create an instance using the builder pattern

     GraphQLInvalidItemShippingDetailsError graphQLInvalidItemShippingDetailsError = GraphQLInvalidItemShippingDetailsError.builder()
             .subject("{subject}")
             .itemId("{itemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVALID_ITEM_SHIPPING_DETAILS	discriminator value for GraphQLInvalidItemShippingDetailsError

Method Summary

Modifier and Type	Method	Description
static GraphQLInvalidItemShippingDetailsErrorBuilder	builder()	builder factory method for GraphQLInvalidItemShippingDetailsError
static GraphQLInvalidItemShippingDetailsErrorBuilder	builder(GraphQLInvalidItemShippingDetailsError template)	create builder for GraphQLInvalidItemShippingDetailsError instance
static GraphQLInvalidItemShippingDetailsError	deepCopy(GraphQLInvalidItemShippingDetailsError template)	factory method to create a deep copy of GraphQLInvalidItemShippingDetailsError
@NotNull String	getCode()	One of the error codes that is listed on the Errors page.
@NotNull String	getItemId()	Unique identifier of the Line Item or Custom Line Item.
@NotNull String	getSubject()	"LineItem" or "CustomLineItem"
static GraphQLInvalidItemShippingDetailsError	of()	factory method
static GraphQLInvalidItemShippingDetailsError	of(GraphQLInvalidItemShippingDetailsError template)	factory method to create a shallow copy GraphQLInvalidItemShippingDetailsError
void	setItemId(String itemId)	Unique identifier of the Line Item or Custom Line Item.
void	setSubject(String subject)	"LineItem" or "CustomLineItem"
static com.fasterxml.jackson.core.type.TypeReference<GraphQLInvalidItemShippingDetailsError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withGraphQLInvalidItemShippingDetailsError(Function<GraphQLInvalidItemShippingDetailsError,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.error.GraphQLErrorObject

setValue, values, withGraphQLErrorObject

Field Details

INVALID_ITEM_SHIPPING_DETAILS

static final String INVALID_ITEM_SHIPPING_DETAILS

discriminator value for GraphQLInvalidItemShippingDetailsError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: GraphQLErrorObject

One of the error codes that is listed on the Errors page.

Specified by:

getCode in interface GraphQLErrorObject

Returns:

code

getSubject

@NotNull
@NotNull String getSubject()

"LineItem" or "CustomLineItem"

Returns:

subject

getItemId

@NotNull
@NotNull String getItemId()

Unique identifier of the Line Item or Custom Line Item.

Returns:

itemId

setSubject

void setSubject(String subject)

"LineItem" or "CustomLineItem"

Parameters:

subject - value to be set

setItemId

void setItemId(String itemId)

Unique identifier of the Line Item or Custom Line Item.

Parameters:

itemId - value to be set

of

static GraphQLInvalidItemShippingDetailsError of()

factory method

Returns:

instance of GraphQLInvalidItemShippingDetailsError

of

static GraphQLInvalidItemShippingDetailsError of(GraphQLInvalidItemShippingDetailsError template)

factory method to create a shallow copy GraphQLInvalidItemShippingDetailsError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static GraphQLInvalidItemShippingDetailsError deepCopy(@Nullable
 GraphQLInvalidItemShippingDetailsError template)

factory method to create a deep copy of GraphQLInvalidItemShippingDetailsError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static GraphQLInvalidItemShippingDetailsErrorBuilder builder()

builder factory method for GraphQLInvalidItemShippingDetailsError

Returns:

builder

builder

static GraphQLInvalidItemShippingDetailsErrorBuilder builder(GraphQLInvalidItemShippingDetailsError template)

create builder for GraphQLInvalidItemShippingDetailsError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withGraphQLInvalidItemShippingDetailsError

default <T> T withGraphQLInvalidItemShippingDetailsError(Function<GraphQLInvalidItemShippingDetailsError,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<GraphQLInvalidItemShippingDetailsError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference