Create group order responses

Possible responses when creating a group order

Status	Meaning	Description	Schema
200	OK	Returns an object representing the ID of your successfully created group order.	GroupOrderResponse
400	Bad Request	Returned when Shippit has a problem with the input parameters. Not all input errors result in this error. Depending on the request, the error might be parsed as an unknown error or as part of the response body. If returned as text or html, it’s blank.	string
403	Forbidden	Returned when the API key given does not match a valid merchant account.	GenericErrorResponse
500	Internal Server Error	Returned when an unknown error occurs. This can happen 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.

Create group order examples

Example responses:

Successful create group order response

Returns an object containing the ID of the successfully created group order:

{
    "id": "GOFIHRxykEyiP"
}

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."
}

400 Response:

"string"

Returned when the reference number isn’t provided:

{
    "errors": {
        "reference_number": "field must be provided"
    }
}

Returned when the reference number type is wrong:

{
    "errors": {
        "reference_number": "is not a string value"
    }
}

Returned when an unknown error occurs. This can happen if Shippit has trouble with the combination of the input or merchant account configuration:

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