Package com.hybris.cis.client.shipping

Interface ShippingClient

  • All Superinterfaces:
    CisClient
    All Known Implementing Classes:
    ShippingClientMock
    public interface ShippingClient
extends CisClient
    Charon Client to the com.hybris.cis.api.shipping.service.ShippingService.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      CisShipment createShipment​(java.lang.String xClientRef, java.lang.String tenantId, CisShipment cisShipment)
      Creates a shipment.
      byte[] getLabel​(java.lang.String xClientRef, java.lang.String tenantId, java.lang.String shipmentId, java.lang.String labelId)
      Gets the shipment label.

    • Method Detail

      • createShipment

        @POST
@Produces("application/json")
@Consumes("application/json")
@Path("/shipments")
CisShipment createShipment​(@HeaderParam("X-CIS-Client-ref")
                           java.lang.String xClientRef,
                           @HeaderParam("X-tenantId")
                           java.lang.String tenantId,
                           CisShipment cisShipment)
        Creates a shipment.
        Parameters:
        xClientRef - client ref to pass in the header
        tenantId - tenantId to pass in the header
        cisShipment - shipment to create
        Returns:
        the shipment

      • getLabel

        @GET
@Produces("application/json")
@Consumes("application/json")
@Path("/shipments/{shipmentId}/labels/{labelId}")
byte[] getLabel​(@HeaderParam("X-CIS-Client-ref")
                java.lang.String xClientRef,
                @HeaderParam("X-tenantId")
                java.lang.String tenantId,
                @PathParam("shipmentId")
                java.lang.String shipmentId,
                @PathParam("labelId")
                java.lang.String labelId)
        Gets the shipment label.
        Parameters:
        xClientRef - client ref to pass in the header
        tenantId - tenantId to pass in the header
        shipmentId - the shipment id
        labelId - the label id
        Returns:
        the label as a stream (can be different files format, see the media type of the rest response)