PublicAPIService
Click here for a complete list of operations.
saveItem
Updates the specified item.
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 /PIP/publicAPIService.asmx HTTP/1.1 Host: einfo.gfidigital.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/saveItem" <?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> <saveItem xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <Auth> <User>string</User> <Password>string</Password> <CompanyID>string</CompanyID> <Version>string</Version> <PartnerToken>string</PartnerToken> </Auth> <Item> <Item> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Item> <Description> <Value>string</Value> <Valid>boolean</Valid> </Description> <BarCode> <Value>string</Value> <Valid>boolean</Valid> </BarCode> <Serialized> <Value>boolean</Value> <Valid>boolean</Valid> </Serialized> <ItemType> <Value>int</Value> <Valid>boolean</Valid> </ItemType> <SalesCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </SalesCode> <InventoryCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </InventoryCode> <EquipmentCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </EquipmentCode> <ServiceCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </ServiceCode> <ServiceCodeCategory> <Value>string</Value> <Valid>boolean</Valid> </ServiceCodeCategory> <WebEnabled> <Value>boolean</Value> <Valid>boolean</Valid> </WebEnabled> <UnitOfMeasure> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </UnitOfMeasure> <CategoryCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </CategoryCode> <Yield> <Value>int</Value> <Valid>boolean</Valid> </Yield> <Weight> <Value>decimal</Value> <Valid>boolean</Valid> </Weight> <WeightUnitOfMeasure> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </WeightUnitOfMeasure> <Make> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Make> <Model> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Model> <TaxFlag> <Value>int</Value> <Valid>boolean</Valid> </TaxFlag> <OnHandQty> <Value>decimal</Value> <Valid>boolean</Valid> </OnHandQty> <Ordered> <Value>decimal</Value> <Valid>boolean</Valid> </Ordered> <Allocated> <Value>decimal</Value> <Valid>boolean</Valid> </Allocated> <Active> <Value>boolean</Value> <Valid>boolean</Valid> </Active> <Remarks> <Value>string</Value> <Valid>boolean</Valid> </Remarks> <StandardQty> <Value>decimal</Value> <Valid>boolean</Valid> </StandardQty> <DefectiveQty> <Value>decimal</Value> <Valid>boolean</Valid> </DefectiveQty> <UnavailableQty> <Value>decimal</Value> <Valid>boolean</Valid> </UnavailableQty> <Cost> <Value>decimal</Value> <Valid>boolean</Valid> </Cost> <MSRP> <Value>decimal</Value> <Valid>boolean</Valid> </MSRP> <Metered> <Value>boolean</Value> <Valid>boolean</Valid> </Metered> <VendorStatus> <Value>string</Value> <Valid>boolean</Valid> </VendorStatus> <IntroductionDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </IntroductionDate> <Segment> <Value>string</Value> <Valid>boolean</Valid> </Segment> <OEMNumber> <Value>string</Value> <Valid>boolean</Valid> </OEMNumber> <OEMCompatible> <Value>boolean</Value> <Valid>boolean</Valid> </OEMCompatible> <Returnable> <Value>boolean</Value> <Valid>boolean</Valid> </Returnable> <TrackingConfig> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </TrackingConfig> <ItemTypeDescription> <Value>string</Value> <Valid>boolean</Valid> </ItemTypeDescription> <PrefMfgNumber> <Value>string</Value> <Valid>boolean</Valid> </PrefMfgNumber> <NoteCount>int</NoteCount> <NoteID>int</NoteID> <CustomProperties> <CustomProperty> <ID>int</ID> <Name>string</Name> <Value>string</Value> <IDVal>int</IDVal> </CustomProperty> <CustomProperty> <ID>int</ID> <Name>string</Name> <Value>string</Value> <IDVal>int</IDVal> </CustomProperty> </CustomProperties> </Item> </saveItem> </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> <saveItemResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <saveItemResult> <ApiResult>boolean</ApiResult> <Details> <ResultDetail> <ResultType>int</ResultType> <ResultCode>int</ResultCode> <ResultString>string</ResultString> </ResultDetail> <ResultDetail> <ResultType>int</ResultType> <ResultCode>int</ResultCode> <ResultString>string</ResultString> </ResultDetail> </Details> </saveItemResult> </saveItemResponse> </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 /PIP/publicAPIService.asmx HTTP/1.1 Host: einfo.gfidigital.com 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> <saveItem xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <Auth> <User>string</User> <Password>string</Password> <CompanyID>string</CompanyID> <Version>string</Version> <PartnerToken>string</PartnerToken> </Auth> <Item> <Item> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Item> <Description> <Value>string</Value> <Valid>boolean</Valid> </Description> <BarCode> <Value>string</Value> <Valid>boolean</Valid> </BarCode> <Serialized> <Value>boolean</Value> <Valid>boolean</Valid> </Serialized> <ItemType> <Value>int</Value> <Valid>boolean</Valid> </ItemType> <SalesCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </SalesCode> <InventoryCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </InventoryCode> <EquipmentCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </EquipmentCode> <ServiceCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </ServiceCode> <ServiceCodeCategory> <Value>string</Value> <Valid>boolean</Valid> </ServiceCodeCategory> <WebEnabled> <Value>boolean</Value> <Valid>boolean</Valid> </WebEnabled> <UnitOfMeasure> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </UnitOfMeasure> <CategoryCode> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </CategoryCode> <Yield> <Value>int</Value> <Valid>boolean</Valid> </Yield> <Weight> <Value>decimal</Value> <Valid>boolean</Valid> </Weight> <WeightUnitOfMeasure> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </WeightUnitOfMeasure> <Make> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Make> <Model> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </Model> <TaxFlag> <Value>int</Value> <Valid>boolean</Valid> </TaxFlag> <OnHandQty> <Value>decimal</Value> <Valid>boolean</Valid> </OnHandQty> <Ordered> <Value>decimal</Value> <Valid>boolean</Valid> </Ordered> <Allocated> <Value>decimal</Value> <Valid>boolean</Valid> </Allocated> <Active> <Value>boolean</Value> <Valid>boolean</Valid> </Active> <Remarks> <Value>string</Value> <Valid>boolean</Valid> </Remarks> <StandardQty> <Value>decimal</Value> <Valid>boolean</Valid> </StandardQty> <DefectiveQty> <Value>decimal</Value> <Valid>boolean</Valid> </DefectiveQty> <UnavailableQty> <Value>decimal</Value> <Valid>boolean</Valid> </UnavailableQty> <Cost> <Value>decimal</Value> <Valid>boolean</Valid> </Cost> <MSRP> <Value>decimal</Value> <Valid>boolean</Valid> </MSRP> <Metered> <Value>boolean</Value> <Valid>boolean</Valid> </Metered> <VendorStatus> <Value>string</Value> <Valid>boolean</Valid> </VendorStatus> <IntroductionDate> <Value>dateTime</Value> <ValueAsString> <Value>string</Value> <Valid>boolean</Valid> </ValueAsString> <Valid>boolean</Valid> </IntroductionDate> <Segment> <Value>string</Value> <Valid>boolean</Valid> </Segment> <OEMNumber> <Value>string</Value> <Valid>boolean</Valid> </OEMNumber> <OEMCompatible> <Value>boolean</Value> <Valid>boolean</Valid> </OEMCompatible> <Returnable> <Value>boolean</Value> <Valid>boolean</Valid> </Returnable> <TrackingConfig> <ID> <Value>int</Value> <Valid>boolean</Valid> </ID> <Code> <Value>string</Value> <Valid>boolean</Valid> </Code> </TrackingConfig> <ItemTypeDescription> <Value>string</Value> <Valid>boolean</Valid> </ItemTypeDescription> <PrefMfgNumber> <Value>string</Value> <Valid>boolean</Valid> </PrefMfgNumber> <NoteCount>int</NoteCount> <NoteID>int</NoteID> <CustomProperties> <CustomProperty> <ID>int</ID> <Name>string</Name> <Value>string</Value> <IDVal>int</IDVal> </CustomProperty> <CustomProperty> <ID>int</ID> <Name>string</Name> <Value>string</Value> <IDVal>int</IDVal> </CustomProperty> </CustomProperties> </Item> </saveItem> </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> <saveItemResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService"> <saveItemResult> <ApiResult>boolean</ApiResult> <Details> <ResultDetail> <ResultType>int</ResultType> <ResultCode>int</ResultCode> <ResultString>string</ResultString> </ResultDetail> <ResultDetail> <ResultType>int</ResultType> <ResultCode>int</ResultCode> <ResultString>string</ResultString> </ResultDetail> </Details> </saveItemResult> </saveItemResponse> </soap12:Body> </soap12:Envelope>