adb
Click here for a complete list of operations.
CalculateReportShipments
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /webservice/adb.asmx HTTP/1.1
Host: editor.ynetalbums.co.il
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.arealmedia.com/asmx/adb/CalculateReportShipments"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CalculateReportShipments xmlns="http://schemas.arealmedia.com/asmx/adb">
<key>string</key>
<secretKey>string</secretKey>
<products>
<OrderProductVO>
<mask_entry_id>string</mask_entry_id>
<order_data_id>int</order_data_id>
<product_reference>string</product_reference>
<categoryName>string</categoryName>
<pages_album>int</pages_album>
<pages_album_extra>int</pages_album_extra>
<cover_reference>string</cover_reference>
<window_reference>string</window_reference>
<window_name>string</window_name>
<colour_reference>string</colour_reference>
<colour_name>string</colour_name>
<texture_reference>string</texture_reference>
<texture_containers>boolean</texture_containers>
<quantity>int</quantity>
<unitary_price>double</unitary_price>
<start_price>double</start_price>
<extra_product>double</extra_product>
<extra_product_page>double</extra_product_page>
<extra_cover>double</extra_cover>
<frameVO>
<reference>string</reference>
<type>int</type>
<description>string</description>
<path_frame>string</path_frame>
<thumb_url>string</thumb_url>
<image_url>string</image_url>
<color xsi:nil="true" />
<top_back>string</top_back>
<top_front>string</top_front>
<left_back>string</left_back>
<left_front>string</left_front>
<right_back>string</right_back>
<right_front>string</right_front>
<bottom_back>string</bottom_back>
<bottom_front>string</bottom_front>
<depth>string</depth>
<frame_width>double</frame_width>
<depth_width>double</depth_width>
<offset>double</offset>
</frameVO>
<page_price>double</page_price>
<price>double</price>
<pricePartner>double</pricePartner>
<discount_quantity>double</discount_quantity>
<discount_voucher>double</discount_voucher>
<discount_shipments>double</discount_shipments>
<group_discount>double</group_discount>
<voucherList>
<string>string</string>
<string>string</string>
</voucherList>
<voucher>string</voucher>
<discount_quantity_ref>string</discount_quantity_ref>
<discount_on_payment>boolean</discount_on_payment>
<subtotal>double</subtotal>
<cod_product>string</cod_product>
<cod_cliente>string</cod_cliente>
<process>int</process>
<download>int</download>
<upload_status>int</upload_status>
<productStatus>int</productStatus>
<revision_product>int</revision_product>
<revision_cover>int</revision_cover>
<revision_calendar>int</revision_calendar>
<project_name>string</project_name>
<description>string</description>
<thumbnail>string</thumbnail>
<include_shipments>boolean</include_shipments>
<include_shipments_discount>boolean</include_shipments_discount>
<isAJSONProject>boolean</isAJSONProject>
<isFromV3>boolean</isFromV3>
<allow_with_quantity_discounts>boolean</allow_with_quantity_discounts>
<weight>double</weight>
<available_to_group>boolean</available_to_group>
<totalPages>int</totalPages>
<idFinishProduct>int</idFinishProduct>
<idFinishCover>int</idFinishCover>
<discounts>
<ItemDiscountVO xsi:nil="true" />
<ItemDiscountVO xsi:nil="true" />
</discounts>
<clustered>boolean</clustered>
<coupon>
<campaign_reference>string</campaign_reference>
<enabled>int</enabled>
<campaign_type>int</campaign_type>
<campaign_init>string</campaign_init>
<campaign_end>string</campaign_end>
<number_references_utilizations>int</number_references_utilizations>
<number_references>int</number_references>
<chars_number>int</chars_number>
<infinite>int</infinite>
<discount_on_payment>int</discount_on_payment>
<allow_with_quantity_discount>int</allow_with_quantity_discount>
<allow_with_finishes>int</allow_with_finishes>
<include_shipments>int</include_shipments>
<include_shipments_discount>int</include_shipments_discount>
<value>double</value>
<shipments_value>double</shipments_value>
<id_voucher>string</id_voucher>
<max_utilizations>int</max_utilizations>
<current_utilizations>int</current_utilizations>
<prepaid>int</prepaid>
<id_watermark>int</id_watermark>
<prepaid_value>double</prepaid_value>
</coupon>
<extraCode1>string</extraCode1>
<extraCode2>string</extraCode2>
<description_finish_product>string</description_finish_product>
<description_finish_cover>string</description_finish_cover>
<path_cliente>string</path_cliente>
<url_cliente>string</url_cliente>
<obs_item>string</obs_item>
<id_printer>int</id_printer>
<havePrapaid>boolean</havePrapaid>
<idUrlProject>int</idUrlProject>
<coupons_applied>
<CouponVO xsi:nil="true" />
<CouponVO xsi:nil="true" />
</coupons_applied>
<encodeQuality>int</encodeQuality>
<scaleCover>double</scaleCover>
<scaleProduct>double</scaleProduct>
<scalePrice>double</scalePrice>
<product />
<idProject>int</idProject>
<observations>string</observations>
<themeReference>string</themeReference>
<coverTemplateId>string</coverTemplateId>
<updateItem>boolean</updateItem>
</OrderProductVO>
<OrderProductVO>
<mask_entry_id>string</mask_entry_id>
<order_data_id>int</order_data_id>
<product_reference>string</product_reference>
<categoryName>string</categoryName>
<pages_album>int</pages_album>
<pages_album_extra>int</pages_album_extra>
<cover_reference>string</cover_reference>
<window_reference>string</window_reference>
<window_name>string</window_name>
<colour_reference>string</colour_reference>
<colour_name>string</colour_name>
<texture_reference>string</texture_reference>
<texture_containers>boolean</texture_containers>
<quantity>int</quantity>
<unitary_price>double</unitary_price>
<start_price>double</start_price>
<extra_product>double</extra_product>
<extra_product_page>double</extra_product_page>
<extra_cover>double</extra_cover>
<frameVO>
<reference>string</reference>
<type>int</type>
<description>string</description>
<path_frame>string</path_frame>
<thumb_url>string</thumb_url>
<image_url>string</image_url>
<color xsi:nil="true" />
<top_back>string</top_back>
<top_front>string</top_front>
<left_back>string</left_back>
<left_front>string</left_front>
<right_back>string</right_back>
<right_front>string</right_front>
<bottom_back>string</bottom_back>
<bottom_front>string</bottom_front>
<depth>string</depth>
<frame_width>double</frame_width>
<depth_width>double</depth_width>
<offset>double</offset>
</frameVO>
<page_price>double</page_price>
<price>double</price>
<pricePartner>double</pricePartner>
<discount_quantity>double</discount_quantity>
<discount_voucher>double</discount_voucher>
<discount_shipments>double</discount_shipments>
<group_discount>double</group_discount>
<voucherList>
<string>string</string>
<string>string</string>
</voucherList>
<voucher>string</voucher>
<discount_quantity_ref>string</discount_quantity_ref>
<discount_on_payment>boolean</discount_on_payment>
<subtotal>double</subtotal>
<cod_product>string</cod_product>
<cod_cliente>string</cod_cliente>
<process>int</process>
<download>int</download>
<upload_status>int</upload_status>
<productStatus>int</productStatus>
<revision_product>int</revision_product>
<revision_cover>int</revision_cover>
<revision_calendar>int</revision_calendar>
<project_name>string</project_name>
<description>string</description>
<thumbnail>string</thumbnail>
<include_shipments>boolean</include_shipments>
<include_shipments_discount>boolean</include_shipments_discount>
<isAJSONProject>boolean</isAJSONProject>
<isFromV3>boolean</isFromV3>
<allow_with_quantity_discounts>boolean</allow_with_quantity_discounts>
<weight>double</weight>
<available_to_group>boolean</available_to_group>
<totalPages>int</totalPages>
<idFinishProduct>int</idFinishProduct>
<idFinishCover>int</idFinishCover>
<discounts>
<ItemDiscountVO xsi:nil="true" />
<ItemDiscountVO xsi:nil="true" />
</discounts>
<clustered>boolean</clustered>
<coupon>
<campaign_reference>string</campaign_reference>
<enabled>int</enabled>
<campaign_type>int</campaign_type>
<campaign_init>string</campaign_init>
<campaign_end>string</campaign_end>
<number_references_utilizations>int</number_references_utilizations>
<number_references>int</number_references>
<chars_number>int</chars_number>
<infinite>int</infinite>
<discount_on_payment>int</discount_on_payment>
<allow_with_quantity_discount>int</allow_with_quantity_discount>
<allow_with_finishes>int</allow_with_finishes>
<include_shipments>int</include_shipments>
<include_shipments_discount>int</include_shipments_discount>
<value>double</value>
<shipments_value>double</shipments_value>
<id_voucher>string</id_voucher>
<max_utilizations>int</max_utilizations>
<current_utilizations>int</current_utilizations>
<prepaid>int</prepaid>
<id_watermark>int</id_watermark>
<prepaid_value>double</prepaid_value>
</coupon>
<extraCode1>string</extraCode1>
<extraCode2>string</extraCode2>
<description_finish_product>string</description_finish_product>
<description_finish_cover>string</description_finish_cover>
<path_cliente>string</path_cliente>
<url_cliente>string</url_cliente>
<obs_item>string</obs_item>
<id_printer>int</id_printer>
<havePrapaid>boolean</havePrapaid>
<idUrlProject>int</idUrlProject>
<coupons_applied>
<CouponVO xsi:nil="true" />
<CouponVO xsi:nil="true" />
</coupons_applied>
<encodeQuality>int</encodeQuality>
<scaleCover>double</scaleCover>
<scaleProduct>double</scaleProduct>
<scalePrice>double</scalePrice>
<product />
<idProject>int</idProject>
<observations>string</observations>
<themeReference>string</themeReference>
<coverTemplateId>string</coverTemplateId>
<updateItem>boolean</updateItem>
</OrderProductVO>
</products>
<currency>string</currency>
<sub_total>double</sub_total>
<shipAddress>
<iso>string</iso>
<id_state>int</id_state>
<id_province>int</id_province>
<id_sub_province>int</id_sub_province>
<postal_code>string</postal_code>
<idStore>int</idStore>
<deliveryInStore>boolean</deliveryInStore>
<city>string</city>
</shipAddress>
<ref_category>string</ref_category>
</CalculateReportShipments>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CalculateReportShipmentsResponse xmlns="http://schemas.arealmedia.com/asmx/adb">
<CalculateReportShipmentsResult>
<Products>
<ShipmentProduct>
<product_reference>string</product_reference>
<product_finish>string</product_finish>
<discount>double</discount>
</ShipmentProduct>
<ShipmentProduct>
<product_reference>string</product_reference>
<product_finish>string</product_finish>
<discount>double</discount>
</ShipmentProduct>
</Products>
<PortesTotal>double</PortesTotal>
<DiscountTotal>double</DiscountTotal>
<ProductsInError>
<string>string</string>
<string>string</string>
</ProductsInError>
</CalculateReportShipmentsResult>
</CalculateReportShipmentsResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /webservice/adb.asmx HTTP/1.1
Host: editor.ynetalbums.co.il
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CalculateReportShipments xmlns="http://schemas.arealmedia.com/asmx/adb">
<key>string</key>
<secretKey>string</secretKey>
<products>
<OrderProductVO>
<mask_entry_id>string</mask_entry_id>
<order_data_id>int</order_data_id>
<product_reference>string</product_reference>
<categoryName>string</categoryName>
<pages_album>int</pages_album>
<pages_album_extra>int</pages_album_extra>
<cover_reference>string</cover_reference>
<window_reference>string</window_reference>
<window_name>string</window_name>
<colour_reference>string</colour_reference>
<colour_name>string</colour_name>
<texture_reference>string</texture_reference>
<texture_containers>boolean</texture_containers>
<quantity>int</quantity>
<unitary_price>double</unitary_price>
<start_price>double</start_price>
<extra_product>double</extra_product>
<extra_product_page>double</extra_product_page>
<extra_cover>double</extra_cover>
<frameVO>
<reference>string</reference>
<type>int</type>
<description>string</description>
<path_frame>string</path_frame>
<thumb_url>string</thumb_url>
<image_url>string</image_url>
<color xsi:nil="true" />
<top_back>string</top_back>
<top_front>string</top_front>
<left_back>string</left_back>
<left_front>string</left_front>
<right_back>string</right_back>
<right_front>string</right_front>
<bottom_back>string</bottom_back>
<bottom_front>string</bottom_front>
<depth>string</depth>
<frame_width>double</frame_width>
<depth_width>double</depth_width>
<offset>double</offset>
</frameVO>
<page_price>double</page_price>
<price>double</price>
<pricePartner>double</pricePartner>
<discount_quantity>double</discount_quantity>
<discount_voucher>double</discount_voucher>
<discount_shipments>double</discount_shipments>
<group_discount>double</group_discount>
<voucherList>
<string>string</string>
<string>string</string>
</voucherList>
<voucher>string</voucher>
<discount_quantity_ref>string</discount_quantity_ref>
<discount_on_payment>boolean</discount_on_payment>
<subtotal>double</subtotal>
<cod_product>string</cod_product>
<cod_cliente>string</cod_cliente>
<process>int</process>
<download>int</download>
<upload_status>int</upload_status>
<productStatus>int</productStatus>
<revision_product>int</revision_product>
<revision_cover>int</revision_cover>
<revision_calendar>int</revision_calendar>
<project_name>string</project_name>
<description>string</description>
<thumbnail>string</thumbnail>
<include_shipments>boolean</include_shipments>
<include_shipments_discount>boolean</include_shipments_discount>
<isAJSONProject>boolean</isAJSONProject>
<isFromV3>boolean</isFromV3>
<allow_with_quantity_discounts>boolean</allow_with_quantity_discounts>
<weight>double</weight>
<available_to_group>boolean</available_to_group>
<totalPages>int</totalPages>
<idFinishProduct>int</idFinishProduct>
<idFinishCover>int</idFinishCover>
<discounts>
<ItemDiscountVO xsi:nil="true" />
<ItemDiscountVO xsi:nil="true" />
</discounts>
<clustered>boolean</clustered>
<coupon>
<campaign_reference>string</campaign_reference>
<enabled>int</enabled>
<campaign_type>int</campaign_type>
<campaign_init>string</campaign_init>
<campaign_end>string</campaign_end>
<number_references_utilizations>int</number_references_utilizations>
<number_references>int</number_references>
<chars_number>int</chars_number>
<infinite>int</infinite>
<discount_on_payment>int</discount_on_payment>
<allow_with_quantity_discount>int</allow_with_quantity_discount>
<allow_with_finishes>int</allow_with_finishes>
<include_shipments>int</include_shipments>
<include_shipments_discount>int</include_shipments_discount>
<value>double</value>
<shipments_value>double</shipments_value>
<id_voucher>string</id_voucher>
<max_utilizations>int</max_utilizations>
<current_utilizations>int</current_utilizations>
<prepaid>int</prepaid>
<id_watermark>int</id_watermark>
<prepaid_value>double</prepaid_value>
</coupon>
<extraCode1>string</extraCode1>
<extraCode2>string</extraCode2>
<description_finish_product>string</description_finish_product>
<description_finish_cover>string</description_finish_cover>
<path_cliente>string</path_cliente>
<url_cliente>string</url_cliente>
<obs_item>string</obs_item>
<id_printer>int</id_printer>
<havePrapaid>boolean</havePrapaid>
<idUrlProject>int</idUrlProject>
<coupons_applied>
<CouponVO xsi:nil="true" />
<CouponVO xsi:nil="true" />
</coupons_applied>
<encodeQuality>int</encodeQuality>
<scaleCover>double</scaleCover>
<scaleProduct>double</scaleProduct>
<scalePrice>double</scalePrice>
<product />
<idProject>int</idProject>
<observations>string</observations>
<themeReference>string</themeReference>
<coverTemplateId>string</coverTemplateId>
<updateItem>boolean</updateItem>
</OrderProductVO>
<OrderProductVO>
<mask_entry_id>string</mask_entry_id>
<order_data_id>int</order_data_id>
<product_reference>string</product_reference>
<categoryName>string</categoryName>
<pages_album>int</pages_album>
<pages_album_extra>int</pages_album_extra>
<cover_reference>string</cover_reference>
<window_reference>string</window_reference>
<window_name>string</window_name>
<colour_reference>string</colour_reference>
<colour_name>string</colour_name>
<texture_reference>string</texture_reference>
<texture_containers>boolean</texture_containers>
<quantity>int</quantity>
<unitary_price>double</unitary_price>
<start_price>double</start_price>
<extra_product>double</extra_product>
<extra_product_page>double</extra_product_page>
<extra_cover>double</extra_cover>
<frameVO>
<reference>string</reference>
<type>int</type>
<description>string</description>
<path_frame>string</path_frame>
<thumb_url>string</thumb_url>
<image_url>string</image_url>
<color xsi:nil="true" />
<top_back>string</top_back>
<top_front>string</top_front>
<left_back>string</left_back>
<left_front>string</left_front>
<right_back>string</right_back>
<right_front>string</right_front>
<bottom_back>string</bottom_back>
<bottom_front>string</bottom_front>
<depth>string</depth>
<frame_width>double</frame_width>
<depth_width>double</depth_width>
<offset>double</offset>
</frameVO>
<page_price>double</page_price>
<price>double</price>
<pricePartner>double</pricePartner>
<discount_quantity>double</discount_quantity>
<discount_voucher>double</discount_voucher>
<discount_shipments>double</discount_shipments>
<group_discount>double</group_discount>
<voucherList>
<string>string</string>
<string>string</string>
</voucherList>
<voucher>string</voucher>
<discount_quantity_ref>string</discount_quantity_ref>
<discount_on_payment>boolean</discount_on_payment>
<subtotal>double</subtotal>
<cod_product>string</cod_product>
<cod_cliente>string</cod_cliente>
<process>int</process>
<download>int</download>
<upload_status>int</upload_status>
<productStatus>int</productStatus>
<revision_product>int</revision_product>
<revision_cover>int</revision_cover>
<revision_calendar>int</revision_calendar>
<project_name>string</project_name>
<description>string</description>
<thumbnail>string</thumbnail>
<include_shipments>boolean</include_shipments>
<include_shipments_discount>boolean</include_shipments_discount>
<isAJSONProject>boolean</isAJSONProject>
<isFromV3>boolean</isFromV3>
<allow_with_quantity_discounts>boolean</allow_with_quantity_discounts>
<weight>double</weight>
<available_to_group>boolean</available_to_group>
<totalPages>int</totalPages>
<idFinishProduct>int</idFinishProduct>
<idFinishCover>int</idFinishCover>
<discounts>
<ItemDiscountVO xsi:nil="true" />
<ItemDiscountVO xsi:nil="true" />
</discounts>
<clustered>boolean</clustered>
<coupon>
<campaign_reference>string</campaign_reference>
<enabled>int</enabled>
<campaign_type>int</campaign_type>
<campaign_init>string</campaign_init>
<campaign_end>string</campaign_end>
<number_references_utilizations>int</number_references_utilizations>
<number_references>int</number_references>
<chars_number>int</chars_number>
<infinite>int</infinite>
<discount_on_payment>int</discount_on_payment>
<allow_with_quantity_discount>int</allow_with_quantity_discount>
<allow_with_finishes>int</allow_with_finishes>
<include_shipments>int</include_shipments>
<include_shipments_discount>int</include_shipments_discount>
<value>double</value>
<shipments_value>double</shipments_value>
<id_voucher>string</id_voucher>
<max_utilizations>int</max_utilizations>
<current_utilizations>int</current_utilizations>
<prepaid>int</prepaid>
<id_watermark>int</id_watermark>
<prepaid_value>double</prepaid_value>
</coupon>
<extraCode1>string</extraCode1>
<extraCode2>string</extraCode2>
<description_finish_product>string</description_finish_product>
<description_finish_cover>string</description_finish_cover>
<path_cliente>string</path_cliente>
<url_cliente>string</url_cliente>
<obs_item>string</obs_item>
<id_printer>int</id_printer>
<havePrapaid>boolean</havePrapaid>
<idUrlProject>int</idUrlProject>
<coupons_applied>
<CouponVO xsi:nil="true" />
<CouponVO xsi:nil="true" />
</coupons_applied>
<encodeQuality>int</encodeQuality>
<scaleCover>double</scaleCover>
<scaleProduct>double</scaleProduct>
<scalePrice>double</scalePrice>
<product />
<idProject>int</idProject>
<observations>string</observations>
<themeReference>string</themeReference>
<coverTemplateId>string</coverTemplateId>
<updateItem>boolean</updateItem>
</OrderProductVO>
</products>
<currency>string</currency>
<sub_total>double</sub_total>
<shipAddress>
<iso>string</iso>
<id_state>int</id_state>
<id_province>int</id_province>
<id_sub_province>int</id_sub_province>
<postal_code>string</postal_code>
<idStore>int</idStore>
<deliveryInStore>boolean</deliveryInStore>
<city>string</city>
</shipAddress>
<ref_category>string</ref_category>
</CalculateReportShipments>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CalculateReportShipmentsResponse xmlns="http://schemas.arealmedia.com/asmx/adb">
<CalculateReportShipmentsResult>
<Products>
<ShipmentProduct>
<product_reference>string</product_reference>
<product_finish>string</product_finish>
<discount>double</discount>
</ShipmentProduct>
<ShipmentProduct>
<product_reference>string</product_reference>
<product_finish>string</product_finish>
<discount>double</discount>
</ShipmentProduct>
</Products>
<PortesTotal>double</PortesTotal>
<DiscountTotal>double</DiscountTotal>
<ProductsInError>
<string>string</string>
<string>string</string>
</ProductsInError>
</CalculateReportShipmentsResult>
</CalculateReportShipmentsResponse>
</soap12:Body>
</soap12:Envelope>