docs.jsonld
type: ApiDocumentation
title: Seven Senders API
description: Shipment API for Seven Senders Network
entrypoint: /v2
supported class: Auth
supported class: InnerCarrier
supported class: Carrier
supported class: CarrierSelection
supported class: ClearingEvent
supported class: Manifest
supported class: CustomsShipment
supported class: SkuMasterData
supported class: TrackingEvent
supported class: ReturnWarehouseFinder
supported class: Dimensions
supported class: Label
supported class: LabelDownload
supported class: LabelItem
supported class: Order
supported class: OrderItem
supported class: OrderState
supported class: Product
supported class: ProductImage
supported class: Location
supported class: LocationByAddress
supported class: LocationByCoordinate
supported class: LocationByLocation
supported class: ServiceParameters
supported class: Shipment
supported class: ShipmentEvent
supported class: ShipmentTrackingHistory
supported class: Warehouse
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

Auth
type: Class
title: Auth
supported property: SupportedProperty
  property: access_key
  title: access_key
  required: false
  readable: true
  writable: true
supported operation: Creates a Auth resource.
  type: Operation
  type: CreateAction
  expects: Auth
  method: POST
  title: Creates a Auth resource.
  returns: Auth

access_key
type: Property
domain: Auth

InnerCarrier
type: Class
title: InnerCarrier
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: true
  readable: true
  writable: true
supported operation: Retrieves InnerCarrier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves InnerCarrier resource.
  returns: InnerCarrier

name
type: Property
domain: InnerCarrier
range: string

country
type: Property
domain: InnerCarrier
range: string

Carrier
type: Class
title: Carrier
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: countries
  title: countries
  required: true
  readable: true
  writable: true
supported operation: Retrieves Carrier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Carrier resource.
  returns: Carrier

code
type: Property
domain: Carrier
range: string

name
type: Property
domain: Carrier
range: string

countries
type: Property
domain: Carrier

CarrierSelection
type: Class
title: CarrierSelection
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writable: true

name
type: Property
domain: CarrierSelection
range: string

country
type: Property
domain: CarrierSelection
range: string

code
type: Property
domain: CarrierSelection
range: string

ClearingEvent
type: Class
title: ClearingEvent
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_clearance_datetime
  title: customs_clearance_datetime
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: type_of_declaration
  title: type_of_declaration
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: manifest_id
  title: manifest_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: shipment_id
  title: shipment_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: local_customs_system_order_no
  title: local_customs_system_order_no
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_references
  title: customs_references
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: skus
  title: skus
  required: false
  readable: true
  writable: true
supported operation: Creates a ClearingEvent resource.
  type: Operation
  type: CreateAction
  expects: ClearingEvent
  method: POST
  title: Creates a ClearingEvent resource.
  returns: ClearingEvent

status
type: Property
domain: ClearingEvent

customs_clearance_datetime
type: Property
domain: ClearingEvent

type_of_declaration
type: Property
domain: ClearingEvent

manifest_id
type: Property
domain: ClearingEvent

shipment_id
type: Property
domain: ClearingEvent

local_customs_system_order_no
type: Property
domain: ClearingEvent

customs_references
type: Property
domain: ClearingEvent

skus
type: Property
domain: ClearingEvent

Manifest
type: Class
title: Manifest
supported property: SupportedProperty
  property: shipment_ids
  title: shipment_ids
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: pieces
  title: pieces
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: reference
  title: reference
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: manifest_id
  title: manifest_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: consignment_id
  title: consignment_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: consignment_net_weight
  title: consignment_net_weight
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: consignment_gross_weight
  title: consignment_gross_weight
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: consignment_total_weight
  title: consignment_total_weight
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: consignment_weight_um
  title: consignment_weight_um
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: pieces_unit_type
  title: pieces_unit_type
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: place_of_incoterm
  title: place_of_incoterm
  required: false
  readable: true
  writable: true
supported operation: Retrieves Manifest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Manifest resource.
  returns: Manifest

shipment_ids
type: Property
domain: Manifest

pieces
type: Property
domain: Manifest
range: integer

reference
type: Property
domain: Manifest
range: string

manifest_id
type: Property
domain: Manifest
range: string

comment
type: Property
domain: Manifest
range: string

consignment_id
type: Property
domain: Manifest
range: string

consignment_net_weight
type: Property
domain: Manifest
range: decimal

consignment_gross_weight
type: Property
domain: Manifest
range: decimal

consignment_total_weight
type: Property
domain: Manifest
range: decimal

consignment_weight_um
type: Property
domain: Manifest
range: string

pieces_unit_type
type: Property
domain: Manifest
range: string

place_of_incoterm
type: Property
domain: Manifest
range: string

CustomsShipment
type: Class
title: CustomsShipment
supported property: SupportedProperty
  property: shipment_id
  title: shipment_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: order_id
  title: order_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: invoice_id
  title: invoice_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: invoice_date
  title: invoice_date
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: incoterm
  title: incoterm
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: tracking_code
  title: tracking_code
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: return_tracking_code
  title: return_tracking_code
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: planned_pickup_datetime
  title: planned_pickup_datetime
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: departure_country
  title: departure_country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: departure_country_customs_id
  title: departure_country_customs_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: arrival_country_customs_id
  title: arrival_country_customs_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: net_weight
  title: net_weight
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: gross_weight
  title: gross_weight
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: weight_um
  title: weight_um
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: departure_country_currency
  title: departure_country_currency
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: consignment_id
  title: consignment_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: packaging
  title: packaging
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: reference_number
  title: reference_number
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: is_return
  title: is_return
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: parent_container
  title: parent_container
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: arrival_country_currency
  title: arrival_country_currency
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient
  title: recipient
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: skus
  title: skus
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: return_inspected
  title: return_inspected
  required: false
  readable: true
  writable: false
supported operation: Retrieves CustomsShipment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves CustomsShipment resource.
  returns: CustomsShipment
supported operation: Deletes the CustomsShipment resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the CustomsShipment resource.
  returns: Nothing
supported operation: Replaces the CustomsShipment resource.
  type: Operation
  type: ReplaceAction
  expects: CustomsShipment
  method: PUT
  title: Replaces the CustomsShipment resource.
  returns: CustomsShipment

shipment_id
type: Property
domain: CustomsShipment

order_id
type: Property
domain: CustomsShipment

invoice_id
type: Property
domain: CustomsShipment

invoice_date
type: Property
domain: CustomsShipment

incoterm
type: Property
domain: CustomsShipment

tracking_code
type: Property
domain: CustomsShipment

return_tracking_code
type: Property
domain: CustomsShipment

planned_pickup_datetime
type: Property
domain: CustomsShipment

departure_country
type: Property
domain: CustomsShipment

departure_country_customs_id
type: Property
domain: CustomsShipment

arrival_country_customs_id
type: Property
domain: CustomsShipment

net_weight
type: Property
domain: CustomsShipment

gross_weight
type: Property
domain: CustomsShipment

weight_um
type: Property
domain: CustomsShipment

departure_country_currency
type: Property
domain: CustomsShipment

consignment_id
type: Property
domain: CustomsShipment

packaging
type: Property
domain: CustomsShipment

reference_number
type: Property
domain: CustomsShipment

is_return
type: Property
domain: CustomsShipment

parent_container
type: Property
domain: CustomsShipment

arrival_country_currency
type: Property
domain: CustomsShipment

recipient
type: Property
domain: CustomsShipment

skus
type: Property
domain: CustomsShipment

status
type: Property
domain: CustomsShipment

type
type: Property
domain: CustomsShipment

return_inspected
type: Property
domain: CustomsShipment

SkuMasterData
type: Class
title: SkuMasterData
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writable: true
supported operation: Retrieves SkuMasterData resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SkuMasterData resource.
  returns: SkuMasterData
supported operation: Deletes the SkuMasterData resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the SkuMasterData resource.
  returns: Nothing
supported operation: Replaces the SkuMasterData resource.
  type: Operation
  type: ReplaceAction
  expects: SkuMasterData
  method: PUT
  title: Replaces the SkuMasterData resource.
  returns: SkuMasterData

id
type: Property
domain: SkuMasterData

TrackingEvent
type: Class
title: TrackingEvent
supported property: SupportedProperty
  property: shipment_id
  title: shipment_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: tracking_code
  title: tracking_code
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: event_code
  title: event_code
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: timestamp
  title: timestamp
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: location
  title: location
  required: false
  readable: true
  writable: true
supported operation: Retrieves TrackingEvent resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TrackingEvent resource.
  returns: TrackingEvent

shipment_id
type: Property
domain: TrackingEvent

tracking_code
type: Property
domain: TrackingEvent

event_code
type: Property
domain: TrackingEvent

message
type: Property
domain: TrackingEvent

timestamp
type: Property
domain: TrackingEvent

location
type: Property
domain: TrackingEvent

ReturnWarehouseFinder
type: Class
title: ReturnWarehouseFinder
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writable: true
supported operation: Retrieves ReturnWarehouseFinder resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ReturnWarehouseFinder resource.
  returns: ReturnWarehouseFinder
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writable: true
supported operation: Retrieves ReturnWarehouseFinder resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ReturnWarehouseFinder resource.
  returns: ReturnWarehouseFinder

data
type: Property
domain: ReturnWarehouseFinder

Dimensions
type: Class
title: Dimensions
supported property: SupportedProperty
  property: height
  title: height
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: length
  title: length
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: width
  title: width
  required: false
  readable: true
  writable: true
supported operation: Retrieves Dimensions resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Dimensions resource.
  returns: Dimensions

height
type: Property
domain: Dimensions
range: decimal

length
type: Property
domain: Dimensions
range: decimal

width
type: Property
domain: Dimensions
range: decimal

Label
type: Class
title: Label
supported property: SupportedProperty
  property: reference_number
  title: reference_number
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: tracking_code
  title: tracking_code
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: outbound
  title: outbound
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: return
  title: return
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: goods_value
  title: goods_value
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: goods_value_currency
  title: goods_value_currency
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: local_delivery
  title: local_delivery
  required: false
  readable: true
  writable: true
supported operation: Retrieves Label resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Label resource.
  returns: Label
supported operation: Deletes the Label resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Label resource.
  returns: Nothing

reference_number
type: Property
domain: Label
range: string

tracking_code
type: Property
domain: Label
range: string

outbound
type: Property
domain: Label
max cardinality: 1
range: LabelItem

return
type: Property
domain: Label
max cardinality: 1
range: LabelItem

goods_value
type: Property
domain: Label
range: decimal

goods_value_currency
type: Property
domain: Label
range: string

local_delivery
type: Property
domain: Label
range: boolean

LabelDownload
type: Class
title: LabelDownload
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writable: true
supported operation: Retrieves LabelDownload resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves LabelDownload resource.
  returns: LabelDownload

id
type: Property
domain: LabelDownload
range: string

LabelItem
type: Class
title: LabelItem
supported property: SupportedProperty
  property: label_url
  title: label_url
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: tracking_code
  title: tracking_code
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: print_format
  title: print_format
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: mime_type
  title: mime_type
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: pickup_point_selected
  title: pickup_point_selected
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: return_address
  title: return_address
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: carrier
  title: carrier
  required: false
  readable: true
  writable: false
supported operation: Retrieves LabelItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves LabelItem resource.
  returns: LabelItem

label_url
type: Property
domain: LabelItem
range: string

tracking_code
type: Property
domain: LabelItem
range: string

print_format
type: Property
domain: LabelItem
range: string

mime_type
type: Property
domain: LabelItem
range: string

pickup_point_selected
type: Property
domain: LabelItem
range: boolean

return_address
type: Property
domain: LabelItem

carrier
type: Property
domain: LabelItem
max cardinality: 1
range: InnerCarrier

Order
type: Class
title: Order
supported property: SupportedProperty
  property: order_id
  title: order_id
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: order_url
  title: order_url
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: order_date
  title: order_date
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: boarding_complete
  title: boarding_complete
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: states_history
  title: states_history
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: order_tags
  title: order_tags
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: promised_delivery_date
  title: promised_delivery_date
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: tracking_page_url
  title: tracking_page_url
  required: false
  readable: true
  writable: true
supported operation: Retrieves Order resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Order resource.
  returns: Order
supported operation: Deletes the Order resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Order resource.
  returns: Nothing
supported operation: Replaces the Order resource.
  type: Operation
  type: ReplaceAction
  expects: Order
  method: PUT
  title: Replaces the Order resource.
  returns: Order

order_id
type: Property
domain: Order
range: string

order_url
type: Property
domain: Order
range: string

order_date
type: Property
domain: Order
range: dateTime

boarding_complete
type: Property
domain: Order
range: boolean

state
type: Property
domain: Order
range: string

language
type: Property
domain: Order
range: string

states_history
type: Property
domain: Order

order_tags
type: Property
domain: Order

promised_delivery_date
type: Property
domain: Order
range: dateTime

tracking_page_url
type: Property
domain: Order
range: string

OrderItem
type: Class
title: OrderItem
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: sku
  title: sku
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: warehouse_address
  title: warehouse_address
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: warehouse
  title: warehouse
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: shop_product_url
  title: shop_product_url
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: sales_price
  title: sales_price
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: currency
  title: currency
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: size
  title: size
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: weight
  title: weight
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: appearance
  title: appearance
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: returnable
  title: returnable
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: bundle_item
  title: bundle_item
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: shop_order_id
  title: shop_order_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: shipment_id
  title: shipment_id
  required: false
  readable: true
  writable: true
supported operation: Retrieves OrderItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OrderItem resource.
  returns: OrderItem
supported operation: Replaces the OrderItem resource.
  type: Operation
  type: ReplaceAction
  expects: OrderItem
  method: PUT
  title: Replaces the OrderItem resource.
  returns: OrderItem
supported operation: Deletes the OrderItem resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the OrderItem resource.
  returns: Nothing

id
type: Property
domain: OrderItem
range: string

sku
type: Property
domain: OrderItem
range: string

warehouse_address
type: Property
domain: OrderItem
range: string

warehouse
type: Property
domain: OrderItem
range: string

shop_product_url
type: Property
domain: OrderItem
range: string

name
type: Property
domain: OrderItem
range: string

description
type: Property
domain: OrderItem
range: string

sales_price
type: Property
domain: OrderItem
range: decimal

currency
type: Property
domain: OrderItem
range: string

size
type: Property
domain: OrderItem
range: string

weight
type: Property
domain: OrderItem
range: decimal

appearance
type: Property
domain: OrderItem
range: string

returnable
type: Property
domain: OrderItem
range: boolean

bundle_item
type: Property
domain: OrderItem
range: string

shop_order_id
type: Property
domain: OrderItem
range: string

status
type: Property
domain: OrderItem
range: string

shipment_id
type: Property
domain: OrderItem
range: string

OrderState
type: Class
title: OrderState
supported property: SupportedProperty
  property: order_id
  title: order_id
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: datetime
  title: datetime
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: location
  title: location
  required: false
  readable: true
  writable: true
supported operation: Retrieves OrderState resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OrderState resource.
  returns: OrderState

order_id
type: Property
domain: OrderState
range: string

state
type: Property
domain: OrderState
range: string

datetime
type: Property
domain: OrderState
range: dateTime

location
type: Property
domain: OrderState
range: string

Product
type: Class
title: Product
supported property: SupportedProperty
  property: sku
  title: sku
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: image_url
  title: image_url
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_description
  title: customs_description
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_item_value
  title: customs_item_value
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_tariff_code_sending_country
  title: customs_tariff_code_sending_country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_tariff_code_receiving_country
  title: customs_tariff_code_receiving_country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: customs_origin_country_iso2
  title: customs_origin_country_iso2
  required: false
  readable: true
  writable: true
supported operation: Retrieves Product resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Product resource.
  returns: Product
supported operation: Deletes the Product resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Product resource.
  returns: Nothing
supported operation: Replaces the Product resource.
  type: Operation
  type: ReplaceAction
  expects: Product
  method: PUT
  title: Replaces the Product resource.
  returns: Product

sku
type: Property
domain: Product
range: string

image_url
type: Property
domain: Product
range: string

customs_description
type: Property
domain: Product
range: string

customs_item_value
type: Property
domain: Product
range: string

customs_tariff_code_sending_country
type: Property
domain: Product
range: string

customs_tariff_code_receiving_country
type: Property
domain: Product
range: string

customs_origin_country_iso2
type: Property
domain: Product
range: string

ProductImage
type: Class
title: ProductImage
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: sku
  title: sku
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: attachment
  title: attachment
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: filename
  title: filename
  required: true
  readable: true
  writable: true
supported operation: Replaces the ProductImage resource.
  type: Operation
  type: ReplaceAction
  expects: ProductImage
  method: PUT
  title: Replaces the ProductImage resource.
  returns: ProductImage
supported operation: Deletes the ProductImage resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProductImage resource.
  returns: Nothing

id
type: Property
domain: ProductImage

sku
type: Property
domain: ProductImage
range: string

attachment
type: Property
domain: ProductImage
range: string

filename
type: Property
domain: ProductImage
range: string

Location
type: Class
title: Location
supported property: SupportedProperty
  property: carrier_name
  title: carrier_name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: coordinates
  title: coordinates
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: house_no
  title: house_no
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_number_of_results
  title: max_number_of_results
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: parcel_sizes
  title: parcel_sizes
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: street
  title: street
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: zip
  title: zip
  required: false
  readable: true
  writable: true

carrier_name
type: Property
domain: Location
range: string

city
type: Property
domain: Location
range: string

coordinates
type: Property
domain: Location

country
type: Property
domain: Location
range: string

house_no
type: Property
domain: Location
range: string

max_number_of_results
type: Property
domain: Location
range: integer

parcel_sizes
type: Property
domain: Location

street
type: Property
domain: Location
range: string

zip
type: Property
domain: Location
range: string

LocationByAddress
type: Class
title: LocationByAddress
supported property: SupportedProperty
  property: zip
  title: zip
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: street
  title: street
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: house_no
  title: house_no
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: carrier_names
  title: carrier_names
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_number_of_results
  title: max_number_of_results
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: parcel_sizes
  title: parcel_sizes
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_distance
  title: max_distance
  required: false
  readable: true
  writable: true

zip
type: Property
domain: LocationByAddress
range: string

city
type: Property
domain: LocationByAddress
range: string

street
type: Property
domain: LocationByAddress
range: string

house_no
type: Property
domain: LocationByAddress
range: string

carrier_names
type: Property
domain: LocationByAddress

country
type: Property
domain: LocationByAddress
range: string

max_number_of_results
type: Property
domain: LocationByAddress
range: string

parcel_sizes
type: Property
domain: LocationByAddress

max_distance
type: Property
domain: LocationByAddress
range: string

LocationByCoordinate
type: Class
title: LocationByCoordinate
supported property: SupportedProperty
  property: latitude
  title: latitude
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: longitude
  title: longitude
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: coordinates
  title: coordinates
  required: false
  readable: true
  writable: false
supported property: SupportedProperty
  property: carrier_names
  title: carrier_names
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_number_of_results
  title: max_number_of_results
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: parcel_sizes
  title: parcel_sizes
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_distance
  title: max_distance
  required: false
  readable: true
  writable: true

latitude
type: Property
domain: LocationByCoordinate
range: string

longitude
type: Property
domain: LocationByCoordinate
range: string

coordinates
type: Property
domain: LocationByCoordinate

carrier_names
type: Property
domain: LocationByCoordinate

country
type: Property
domain: LocationByCoordinate
range: string

max_number_of_results
type: Property
domain: LocationByCoordinate
range: string

parcel_sizes
type: Property
domain: LocationByCoordinate

max_distance
type: Property
domain: LocationByCoordinate
range: string

LocationByLocation
type: Class
title: LocationByLocation
supported property: SupportedProperty
  property: location_id
  title: location_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: carrier_names
  title: carrier_names
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_number_of_results
  title: max_number_of_results
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: parcel_sizes
  title: parcel_sizes
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: max_distance
  title: max_distance
  required: false
  readable: true
  writable: true

location_id
type: Property
domain: LocationByLocation
range: string

carrier_names
type: Property
domain: LocationByLocation

country
type: Property
domain: LocationByLocation
range: string

max_number_of_results
type: Property
domain: LocationByLocation
range: string

parcel_sizes
type: Property
domain: LocationByLocation

max_distance
type: Property
domain: LocationByLocation
range: string

ServiceParameters
type: Class
title: ServiceParameters
supported property: SupportedProperty
  property: destination
  title: destination
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: speed
  title: speed
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: service_group
  title: service_group
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: enhancements
  title: enhancements
  required: false
  readable: true
  writable: true
supported operation: Retrieves ServiceParameters resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ServiceParameters resource.
  returns: ServiceParameters

destination
type: Property
domain: ServiceParameters
range: string

speed
type: Property
domain: ServiceParameters
range: string

service_group
type: Property
domain: ServiceParameters
range: string

enhancements
type: Property
domain: ServiceParameters

Shipment
type: Class
title: Shipment
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: tracking_code
  title: tracking_code
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: reference_number
  title: reference_number
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: pickup_point_selected
  title: pickup_point_selected
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: planned_pickup_datetime
  title: planned_pickup_datetime
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: warehouse_address
  title: warehouse_address
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: warehouse
  title: warehouse
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: shipment_tag
  title: shipment_tag
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_address
  title: recipient_address
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_name
  title: recipient_name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: return_parcel
  title: return_parcel
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: trackable
  title: trackable
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: goods_value
  title: goods_value
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: goods_value_currency
  title: goods_value_currency
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_address_details
  title: recipient_address_details
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: reference_number_2
  title: reference_number_2
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: local_delivery
  title: local_delivery
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: cod_reference
  title: cod_reference
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: order_id
  title: order_id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: carrier_tracking_url
  title: carrier_tracking_url
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: carrier
  title: carrier
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: carrier_service
  title: carrier_service
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_first_name
  title: recipient_first_name
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_last_name
  title: recipient_last_name
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_company_name
  title: recipient_company_name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_email
  title: recipient_email
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_zip
  title: recipient_zip
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_city
  title: recipient_city
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_country
  title: recipient_country
  required: true
  readable: true
  writable: true
supported property: SupportedProperty
  property: recipient_phone
  title: recipient_phone
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: weight
  title: weight
  required: false
  readable: true
  writable: true
supported operation: Retrieves Shipment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Shipment resource.
  returns: Shipment
supported operation: Deletes the Shipment resource.
supported operation: Replaces the Shipment resource.

id
type: Property
domain: Shipment

tracking_code
type: Property
domain: Shipment
range: string

reference_number
type: Property
domain: Shipment
range: string

pickup_point_selected
type: Property
domain: Shipment
range: boolean

planned_pickup_datetime
type: Property
domain: Shipment
range: dateTime

comment
type: Property
domain: Shipment
range: string

warehouse_address
type: Property
domain: Shipment
range: string

warehouse
type: Property
domain: Shipment
range: string

shipment_tag
type: Property
domain: Shipment

recipient_address
type: Property
domain: Shipment
range: string

recipient_name
type: Property
domain: Shipment
range: string

return_parcel
type: Property
domain: Shipment
range: boolean

trackable
type: Property
domain: Shipment
range: boolean

goods_value
type: Property
domain: Shipment
range: decimal

goods_value_currency
type: Property
domain: Shipment
range: string

recipient_address_details
type: Property
domain: Shipment
range: string

reference_number_2
type: Property
domain: Shipment

local_delivery
type: Property
domain: Shipment
range: boolean

cod_reference
type: Property
domain: Shipment
range: string

order_id
type: Property
domain: Shipment
range: string

carrier_tracking_url
type: Property
domain: Shipment
range: string

carrier
type: Property
domain: Shipment
max cardinality: 1
range: InnerCarrier

carrier_service
type: Property
domain: Shipment
range: string

recipient_first_name
type: Property
domain: Shipment
range: string

recipient_last_name
type: Property
domain: Shipment
range: string

recipient_company_name
type: Property
domain: Shipment
range: string

recipient_email
type: Property
domain: Shipment
range: string

recipient_zip
type: Property
domain: Shipment
range: string

recipient_city
type: Property
domain: Shipment
range: string

recipient_country
type: Property
domain: Shipment
range: string

recipient_phone
type: Property
domain: Shipment
range: string

weight
type: Property
domain: Shipment
range: decimal

ShipmentEvent
type: Class
title: ShipmentEvent
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: datetime
  title: datetime
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: event
  title: event
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: meaning
  title: meaning
  required: false
  readable: true
  writable: true

id
type: Property
domain: ShipmentEvent
range: string

datetime
type: Property
domain: ShipmentEvent
range: string

event
type: Property
domain: ShipmentEvent
range: string

status
type: Property
domain: ShipmentEvent
range: string

meaning
type: Property
domain: ShipmentEvent
range: string

ShipmentTrackingHistory
type: Class
title: ShipmentTrackingHistory
supported property: SupportedProperty
  property: creation_date
  title: creation_date
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: event
  title: event
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writable: true

creation_date
type: Property
domain: ShipmentTrackingHistory
range: dateTime

event
type: Property
domain: ShipmentTrackingHistory
range: string

description
type: Property
domain: ShipmentTrackingHistory
range: string

Warehouse
type: Class
title: Warehouse
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writable: true
supported operation: Retrieves Warehouse resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Warehouse resource.
  returns: Warehouse

name
type: Property
domain: Warehouse
range: string

country
type: Property
domain: Warehouse

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Carrier resources
  title: The collection of Carrier resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of CarrierSelection resources
  title: The collection of CarrierSelection resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Manifest resources
  title: The collection of Manifest resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of CustomsShipment resources
  title: The collection of CustomsShipment resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of SkuMasterData resources
  title: The collection of SkuMasterData resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of TrackingEvent resources
  title: The collection of TrackingEvent resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of ReturnWarehouseFinder resources
  title: The collection of ReturnWarehouseFinder resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of ReturnWarehouseFinder resources
  title: The collection of ReturnWarehouseFinder resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Label resources
  title: The collection of Label resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Order resources
  title: The collection of Order resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of OrderItem resources
  title: The collection of OrderItem resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of OrderState resources
  title: The collection of OrderState resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Product resources
  title: The collection of Product resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Location resources
  title: The collection of Location resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of LocationByAddress resources
  title: The collection of LocationByAddress resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of LocationByCoordinate resources
  title: The collection of LocationByCoordinate resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of LocationByLocation resources
  title: The collection of LocationByLocation resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Shipment resources
  title: The collection of Shipment resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of ShipmentEvent resources
  title: The collection of ShipmentEvent resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of ShipmentTrackingHistory resources
  title: The collection of ShipmentTrackingHistory resources
  readable: true
  writable: false
supported property: SupportedProperty
  property: The collection of Warehouse resources
  title: The collection of Warehouse resources
  readable: true
  writable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Carrier resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Carrier
supported operation: Retrieves the collection of Carrier resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Carrier resources.
  returns: Collection

The collection of CarrierSelection resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CarrierSelection
supported operation: Retrieves the collection of CarrierSelection resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CarrierSelection resources.
  returns: Collection

The collection of Manifest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Manifest
supported operation: Creates a Manifest resource.
  type: Operation
  type: CreateAction
  expects: Manifest
  method: POST
  title: Creates a Manifest resource.
  returns: Manifest
supported operation: Retrieves the collection of Manifest resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Manifest resources.
  returns: Collection

The collection of CustomsShipment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CustomsShipment
supported operation: Creates a CustomsShipment resource.
  type: Operation
  type: CreateAction
  expects: CustomsShipment
  method: POST
  title: Creates a CustomsShipment resource.
  returns: CustomsShipment
supported operation: Retrieves the collection of CustomsShipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CustomsShipment resources.
  returns: Collection

The collection of SkuMasterData resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SkuMasterData
supported operation: Creates a SkuMasterData resource.
  type: Operation
  type: CreateAction
  expects: SkuMasterData
  method: POST
  title: Creates a SkuMasterData resource.
  returns: SkuMasterData
supported operation: Retrieves the collection of SkuMasterData resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SkuMasterData resources.
  returns: Collection

The collection of TrackingEvent resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TrackingEvent
supported operation: Creates a TrackingEvent resource.
  type: Operation
  type: CreateAction
  expects: TrackingEvent
  method: POST
  title: Creates a TrackingEvent resource.
  returns: TrackingEvent

The collection of ReturnWarehouseFinder resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ReturnWarehouseFinder
supported operation: Creates a ReturnWarehouseFinder resource.
  type: Operation
  type: CreateAction
  expects: ReturnWarehouseFinder
  method: POST
  title: Creates a ReturnWarehouseFinder resource.
  returns: ReturnWarehouseFinder
range:
  equivalent class:
    on property: member
    all values from: ReturnWarehouseFinder
supported operation: Creates a ReturnWarehouseFinder resource.
  type: Operation
  type: CreateAction
  expects: ReturnWarehouseFinder
  method: POST
  title: Creates a ReturnWarehouseFinder resource.
  returns: ReturnWarehouseFinder

The collection of Label resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Label
supported operation: Creates a Label resource.
  type: Operation
  type: CreateAction
  expects: Label
  method: POST
  title: Creates a Label resource.
  returns: Label

The collection of Order resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Order
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Collection
supported operation: Creates a Order resource.
  type: Operation
  type: CreateAction
  expects: Order
  method: POST
  title: Creates a Order resource.
  returns: Order
supported operation: Deletes the Order resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Order resource.
  returns: Nothing

The collection of OrderItem resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrderItem
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: Collection
supported operation: Creates a OrderItem resource.
  type: Operation
  type: CreateAction
  expects: OrderItem
  method: POST
  title: Creates a OrderItem resource.
  returns: OrderItem

The collection of OrderState resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrderState
supported operation: Creates a OrderState resource.
  type: Operation
  type: CreateAction
  expects: OrderState
  method: POST
  title: Creates a OrderState resource.
  returns: OrderState

The collection of Product resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Product
supported operation: Retrieves the collection of Product resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Product resources.
  returns: Collection
supported operation: Creates a Product resource.
  type: Operation
  type: CreateAction
  expects: Product
  method: POST
  title: Creates a Product resource.
  returns: Product

The collection of Location resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Location
supported operation: Retrieves the collection of Location resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Location resources.
  returns: Collection
supported operation: Creates a Location resource.
  type: Operation
  type: CreateAction
  expects: Location
  method: POST
  title: Creates a Location resource.
  returns: Location

The collection of LocationByAddress resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LocationByAddress
supported operation: Retrieves the collection of LocationByAddress resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of LocationByAddress resources.
  returns: Collection

The collection of LocationByCoordinate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LocationByCoordinate
supported operation: Retrieves the collection of LocationByCoordinate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of LocationByCoordinate resources.
  returns: Collection

The collection of LocationByLocation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LocationByLocation
supported operation: Retrieves the collection of LocationByLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of LocationByLocation resources.
  returns: Collection

The collection of Shipment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Shipment
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Collection
supported operation: Creates a Shipment resource.
  type: Operation
  type: CreateAction
  expects: Shipment
  method: POST
  title: Creates a Shipment resource.
  returns: Shipment

The collection of ShipmentEvent resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShipmentEvent
supported operation: Creates a ShipmentEvent resource.
  type: Operation
  type: CreateAction
  expects: ShipmentEvent
  method: POST
  title: Creates a ShipmentEvent resource.
  returns: ShipmentEvent

The collection of ShipmentTrackingHistory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShipmentTrackingHistory
supported operation: Retrieves the collection of ShipmentTrackingHistory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentTrackingHistory resources.
  returns: Collection

The collection of Warehouse resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Warehouse
supported operation: Retrieves the collection of Warehouse resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Warehouse resources.
  returns: Collection

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

Deletes the Shipment resource.
type: Operation
type: DeleteAction
method: DELETE
title: Deletes the Shipment resource.
returns: Nothing

Replaces the Shipment resource.
type: Operation
type: ReplaceAction
expects: Shipment
method: PUT
title: Replaces the Shipment resource.
returns: Shipment