client
Find a single client.
Arguments
idIDSearch by primary key.
Returns
currencyString!ISO 4217 currency code
valueString!Amount
contextableIdIDThe contextable ID
createdAtDateTimeTz!When the price was created.
idID!Unique primary key.
priceableIdID!The priceable ID
priceableTypePriceableType!The priceable type
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONupdatedAtDateTimeTz!When the price was last updated.
validFromDate!The date from which the price is valid
validToDateThe date until which the price is valid
hasCurrencyConflictBoolean!Whether the client's price lists price the item in different currencies, so no price list price applies.
currencyString!ISO 4217 currency code
valueString!Amount
contextableIdIDThe contextable ID
createdAtDateTimeTz!When the price was created.
idID!Unique primary key.
priceableIdID!The priceable ID
priceableTypePriceableType!The priceable type
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONupdatedAtDateTimeTz!When the price was last updated.
validFromDate!The date from which the price is valid
validToDateThe date until which the price is valid
createdAtDateTimeTz!When the price list was created.
A list of FulfillmentService edges.
pageInfoPageInfo!Pagination information about the list of edges.
idID!Unique primary key.
nameString!Name of the price list
A list of TenantShippingProduct edges.
pageInfoPageInfo!Pagination information about the list of edges.
updatedAtDateTimeTz!When the price list was last updated.
priceableIdID!ID of the priced item.
priceableTypePriceableType!Type of the priced item.
FULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_OPTIONcursorString!A unique cursor that can be used for pagination.
amountMoneyAmount of the billing charge (quantity × unit price), excluding VAT.
businessUnitBusinessUnit!Business unit of the billing charge.
chargeDateDate!Charge date of the billing charge.
chargeKeyString!Charge key of the billing charge.
createdAtDateTimeTz!When the billing charge was created.
descriptionString!Description of the billing charge.
idID!Unique primary key.
invoiceInvoiceInvoice the charge is on (a draft until the invoice is sent).
invoiceLineInvoiceLineInvoice line the charge is aggregated into.
isReprocessableBoolean!Whether this billing charge can be reprocessed.
issueCodeStringIssue code of the billing charge.
ledgerLedgerLedger of the billing charge.
metadataMixedMetadata of the billing charge.
organizationClient!Organization of the billing charge.
originBillingChargeOrigin!Origin of the billing charge.
CARRIER_PASS_THROUGHCREDITFIXED_FEEMANUALMINIMUM_ADJUSTMENTRESOURCESUBSCRIPTIONperiodEndAtDate!End of the billing period.
periodStartAtDate!Start of the billing period.
priceSourceBillingChargePriceSourceWhere the charge's price came from.
priceableBillingChargePriceablePriceable of the billing charge.
priceableIdIDID of the pricing source identified by priceableType.
priceableTypeBillingChargePriceableTypeModel type of the pricing source used for this billing charge.
CARRIER_CHARGE_MAPPINGCARRIER_INVOICE_LINE_CHARGEFULFILLMENTFULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERGOODS_RECEIPTINVENTORY_BILLING_PERIODORGANIZATIONRETURN_RECEIPTSHIPMENTSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_FUEL_SURCHARGESHIPPING_PRODUCT_OPTIONSUBSCRIPTIONpricingModeBillingChargePricingMode!Pricing mode of the billing charge.
CATALOGMANUALPASS_THROUGHSNAPSHOTquantityString!Quantity of the billing charge.
resourceBillingChargeResourceThe resource associated with this billing charge.
subjectIdID!ID of the subject identified by subjectType.
subjectTypeBillingChargeSubjectType!Model type of the subject that generated this billing charge.
CARRIER_CHARGE_MAPPINGCARRIER_INVOICE_LINE_CHARGEFULFILLMENTFULFILLMENT_SERVICE_RULEFULFILLMENT_SERVICE_RULE_TIERGOODS_RECEIPTINVENTORY_BILLING_PERIODORGANIZATIONRETURN_RECEIPTSHIPMENTSHIPPING_PRODUCT_BASESHIPPING_PRODUCT_FUEL_SURCHARGESHIPPING_PRODUCT_OPTIONSUBSCRIPTIONunitPriceMoneyPrice per unit of the billing charge, excluding VAT.
updatedAtDateTimeTz!When the billing charge was last updated.
vatProfileVatProfileVAT profile of the billing charge.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!emailStringidID!isEnabledBoolean!localeStringnameString!phoneStringCUSTOMER_SERVICEFINANCELOGISTICSMANAGEMENTuserUserendCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
features[OrganizationFeature!]!The features associated with this client.
DEMOSUPPORT_AUTOMATIONSUPPORT_TICKETScursorString!A unique cursor that can be used for pagination.
availableBillingUnits[BillingUnit!]!Get available billing units for a fulfillment service type
FIXED_FEEMINIMUM_BILLINGPER_FULFILLMENTPER_GOODS_RECEIPTPER_ITEMPER_LINEPER_LOAD_CARRIERPER_MATERIALPER_OCCUPIED_LOCATION_DAYPER_PRODUCTPER_RETURN_RECEIPTcategoryFulfillmentServiceCategory!Category of the fulfillment service
FIXED_FEEINBOUNDINVENTORYMINIMUM_BILLINGOUTBOUNDRETURNScreatedAtDateTimeTz!When the fulfillment service was created.
idID!Unique primary key.
nameString!Name of the fulfillment service
pricesPriceConnection!Prices of the fulfillment service.
Rules for this fulfillment service
updatedAtDateTimeTz!When the fulfillment service was last updated.
warehouseWarehouse!Warehouse of the fulfillment service.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
The orders associated with this invoice line billable fulfillment.
referenceStringReference of the invoice line billable fulfillment.
statusFulfillmentStatusCurrent status of the invoice line billable fulfillment.
CALCULATINGON_HOLDPACKINGPENDINGPICKEDPICKINGQUEUEDRELEASESHIPPEDUNSCHEDULEDwarehouseWarehouse!Warehouse of the invoice line billable fulfillment.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
statusGoodsReceiptStatusCurrent status of the invoice line billable goods receipt.
ARRIVEDCANCELEDCOMPLETEDEXPECTEDPENDINGwarehouseWarehouse!Warehouse of the invoice line billable goods receipt.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
idID!Unique primary key.
cursorString!A unique cursor that can be used for pagination.
addressAddress!Address of the invoice contact.
billingProfileBillingProfileBilling profile of the invoice contact.
businessUnitBusinessUnitBusiness unit of the invoice contact.
createdAtDateTimeTz!When the invoice contact was created.
idID!Unique primary key.
organizationClient!Organization of the invoice contact.
updatedAtDateTimeTz!When the invoice contact was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
businessUnitBusinessUnitBusiness unit that issues the invoice.
createdAtDateTimeTz!When the invoice was created.
dueAtDateDue at
idID!Unique primary key.
issueCountInt!Blocked charges of this client and business unit whose billing period overlaps the invoice period; they are missing from the invoice until resolved.
The lines associated with this invoice.
numberStringInvoice number
organizationClient!Organization for which the invoice is issued.
periodEndAtDateLast day of the billing period this invoice covers.
periodStartAtDateFirst day of the billing period this invoice covers.
referenceStringOrder / invoice reference
sendingInvoiceSending!Sending of the invoice: whether it can be sent, when it is sent automatically and the progress of a dispatch.
sentAtDateSent at
totalAmountMoneyTotal amount excluding VAT.
totalAmountInclVatMoneyTotal amount including VAT.
updatedAtDateTimeTz!When the invoice was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
nameString!Name of the client
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
referenceStringReference of the invoice line billable order.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
createdAtDateTimeTz!When the price list was created.
fulfillmentServicesFulfillmentServiceConnection!Fulfillment services associated with this price list
idID!Unique primary key.
nameString!Name of the price list
shippingProductsTenantShippingProductConnection!Shipping products associated with this price list
updatedAtDateTimeTz!When the price list was last updated.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
idID!Unique primary key.
statusReturnReceiptStatusCurrent status of the invoice line billable return receipt.
COMPLETEDCREATEDPENDINGwarehouseWarehouse!Warehouse of the invoice line billable return receipt.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
barcodeStringBarcode of the invoice line billable shipment.
idID!Unique primary key.
referenceStringReference of the invoice line billable shipment.
statusShipmentStatus!Current status of the invoice line billable shipment.
CANCELEDCREATEDERRORGENERATEDGENERATINGPRINTEDREQUESTEDSHIPPEDendCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
List shipping product bases
clientsClientConnection!List clients that have this shipping product
List countries explicitly linked to shipping product methods
createdAtDateTimeTz!When the shipping product was created.
fuelSurchargesShippingProductFuelSurchargeConnection!List shipping product fuel surcharges.
idID!Unique primary key.
matricesShippingProductMatrixConnection!The matrices associated with this tenant shipping product.
nameString!Name of the warehouse
List shipping product options.
pricesPriceConnection!List prices for this shipping product
senderAddressesTenantShippingProductSenderAddressConnection!List sender addresses for this shipping product
shippingMethodCountriesTenantShippingProductCountryConnection!List shipping method countries
shippingProductMethodCountriesTenantShippingProductMethodCountryConnection!The shipping product method countries associated with this tenant shipping product.
shippingProductMethodsTenantShippingProductMethodConnection!Shipping product methods of the tenant shipping product.
shippingProductServicesTenantShippingProductServiceConnection!List shipping product services
shippingServiceShippingServiceSpecific linked shipping service
shippingServicesShippingServiceConnection!List linked shipping services
List shipping product sizes.
updatedAtDateTimeTz!When the shipping product was last updated.
List zones for the shipping product.
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
avatarAvatarAvatar of the user.
emailString!Email address
firstnameString!First name
idID!Unique primary key.
lastnameString!Last name
localeString!Locale of the user
rights[TenantRight!]!Rights assigned to the tenant membership.
analyticscarrier_invoicesclient_pricingclientsfinance_analyticsfinance_managerfullinvoicingmcp_readmcp_writeshipping_productssupporttimezoneString!Timezone of the user
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.
cursorString!A unique cursor that can be used for pagination.
avatarAvatarAvatar of the warehouse.
features[WarehouseFeature!]Features
demogoods_receiptinventory_managementorder_fulfillmentpicklist_sortingreturn_processingthird_party_logisticsidID!Unique primary key.
nameString!Name of the warehouse
timezoneString!Timezone of the warehouse
endCursorStringThe cursor to continue paginating forwards.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringThe cursor to continue paginating backwards.