Transmission related operations exposed by this service.
Returns all transmissions for selected search criterias.
|in query||creationDate[gte]||string ||Required | The earliest creation date of a transmission.|
|in query||creationDate[lte]||string ||Required | The latest creation date of a transmission.|
|in query||limit||integer||The number of items to return.|
If not set the limit is 1000.
|in query||offset||integer||The number of items to skip before starting to collect the result set.|
200 - OK The response for a transmission collection request.
400 - Bad Request - Generic or business logic validation error.
401 - Unauthorized - Authentication information is missing or invalid.
403 - Forbidden - the user is not authorized to use this resource.
406 - Not Acceptable - A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.
500 - Internal Server Error - An unexpected error occured.
Attribute XYZ is mandatory
CollectionMetaDataobject. The meta data of collection.
Transmissionobjects. The core data of the transmission collection.
ORDERTRANSMISSION- Transmissions that are used for order processing messages, e.g. to announce an order entry. Subtypes of this type start with
DISPATCHTRANSMISSION- Transmissions that are used for dispatch messages, e.g. a delivery that was made. Subtypes of this type start with
RETURNTRANSMISSION- Transmissions that are used for return messages, e.g. a received return. Subtypes of this type start with
PAYMENTTRANSMISSION- Transmissions that are used for payment notification messages, e.g. a received payment. Subtypes of this type start with
MAILTRANSMISSION- Transmissions that are used for emails, e.g. to send a delivery email to the customer. Subtypes of this type start with
RESPONSETRANSMISSION- Transmissions that are used for response messages, e.g. to respond to a delivery request. Subtypes of this type start with
INVOICETRANSMISSION- Transmissions that are used for invoice processing messages. Subtypes of this type start with
DOCUMENTTRANSMISSION- Transmissions that are used for document processing messages. Subtypes of this type start with
RETURNANNOUNCEMENTTRANSMISSION- Transmissions that are used for return announcements messages. Subtypes of this type start with
OTHERSfor subtypes that are not listed, e.g. custom ones.
ORDERTRANSMISSION| Possible Values:
TransmissionTypeand unknown subtypes, e.g. custom ones. | Example:
INITIAL- Transmission is initially stored.
DO_PULL- Transmission will be pulled.
PULLED- Transmission was received (pulled) from the sender.
DO_PUSH- Transmission can be sent (pushed) to the receiver.
PUSHED- Transmission was sent (pushed) to the receiver.
DO_MANUAL_CHECK- The processing of transmission was canceled because of errors. The transmission has to be checked manually.
CHECKED- The transmission was checked manually and is ready to process.
DO_CANCEL- The transmission will be canceled.
CANCELED- Transmission can be canceled because processing is not required any longer.
TRANSMISSIONED- Transmission was submitted.
CONFIRMED- Transmission was confirmed from the receiver. | Example:
CONFIRMED| Possible Values:
OK- The transmission was successfully received.
INVALID- An error occurred during validation check at the receiver.
REJECTED- The operation was rejected by the receiver.
EXTERNAL_ERROR- An unexpected error occurred at the receiver.
INTERNAL_ERROR- Internal unexpected error has occurred.
NOT_AVAILABLE- The response status is not set. | Example:
REJECTED| Possible Values:
Test Shop US DE
Test Supplier US DE
OMS- The OMS-application itself.
SHOP- The shop is the receiver of the transmission.
SUPPLIER- The supplier is the receiver of the transmission, e.g. of a delivery request.
CUSTOMER- The customer is the receiver of the transmission, e.g. an email to confirm an order.
PAYMENTPROVIDER- A payment provider is the receiver of the transmission, e.g. to note a received payment to.
FINANCECONTROLLER- A finance contoller is the receiver of the transmission, e.g. a debitor management system that receives open amounts. | Example:
SHOP| Possible Values:
This was no error, because the status was set OK.
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.