Merchant API

Get Cart

Get the details for a specific order source setup. Some API credentials provided when setting up the connection may not be returned in this call.

Filters

ArgumentDescription
test_cartY or N. Default N If Y, the cart connection will be tested and the result included in the response.

Array Response Fields

FieldData TypeLengthDescription
order_sourceStringOrder Source assigned to this connection
descriptionStringDescription provided during setup if available
user_keyStringUser Name/ID for this connection if it can be shared.
server_idStringServer URL for this connection, if available.
discontinuedBooleanHas this connection been disabled/discontinued?
iconStringFull url path to image of cart logo for hotlinking.<br>Dimensions: 64x64 px<br>Format: Transparent png
test_successBooleanDid we successfully connect to the cart.
test_messageStringA testing result message will be returned. It may be an error message, or brief instructions if additional setup is needed.
extra_paramsArrayList of all params set and their values, even if they are the system default.
schedulesArrayList of service schedules: order, confirm, inventory. A value of 0 is OFF, anything else means ON.
get/v1/cart/list/{ORDER_SOURCE}

Request

Path parameters

ORDER_SOURCEstring required

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.