Finalise group order responses

Possible responses when finalising a group order

Status	Meaning	Description	Schema
204	No Content	Group order has been successfully finalised. Nothing is returned in the response payload body.	None
403	Forbidden	Returned when the API key given does not match a valid merchant account.	GenericErrorResponse
404	Not Found	Returns an error indicating that the group order couldn’t be found in Shippit	GenericErrorResponse
500	Internal Server Error	Returned when an unknown error occurs. Might be returned if Shippit has trouble with the combination of the input or merchant account configuration.	GenericErrorResponse

To perform this operation, you must be authenticated with an authentication token.

Finalise group order examples

Example responses when finalising a group order.

Successful finalizing the group order

A successful call doesn’t return a response payload body.

Unsuccessful create group order responses

Returned when the API key given doesn’t match a valid merchant account:

{
  "error": "invalid_merchant_account",
  "error_description": "An unknown error has occurred."
}

Returned when the group order ID is wrong:

{
    "error": "not_found",
    "error_description": "The requested resource could not be found."
}

Returned when an unknown error occurs. Might be returned if Shippit has trouble with the combination of the input or merchant account configuration:

{
  "error": "system",
  "error_description": "An unknown error has occurred."
}