For AI agents: markdown of this page — /docs-content-en/entities/delivery-services/fields.md documentation index — /llms.txt
Delivery service fields
Reference for delivery service fields used when reading a service or list and processing the result of creating or updating a service.
Response fields
The table describes records in data when getting a delivery service, items in data[] when listing delivery services, and the record in data after updating. When creating a delivery service, these fields appear in the data.parent object and the items in the data.profiles[] array.
In a list request, select determines which response fields are returned. A field omitted from a selected record differs from a field with a null value.
| Field | Type | RO | Description |
|---|---|---|---|
Fieldid |
Typeinteger | ROyes | DescriptionDelivery service ID. Source: List delivery services |
FieldparentId |
Typeinteger | null | ROyes | DescriptionParent service ID for a delivery profile. Source: List delivery services |
Fieldname |
Typestring | null | ROno | DescriptionDelivery service name |
Fieldactive |
Typestring | null | ROno | DescriptionActivity flag: "Y" means active, "N" means inactive |
Fielddescription |
Typestring | null | ROno | DescriptionDelivery service description |
Fieldcurrency |
Typestring | null | ROno | DescriptionCurrency code, for example USD. See List currencies |
Fieldsort |
Typeinteger | null | ROno | DescriptionDelivery service sort order |
Fieldlogotype |
Typeinteger | null | ROyes | DescriptionLogo file ID, not a URL. Upload a logo using logo when creating or updating a service |
RO means read-only. Writable fields and their required flags are documented on the create and update pages.