Search

Index

Revindex Storefront

ShippingMethod

Last updated on 2023-01-27 3 mins. to read

A ShippingMethod object is to manage shipping during checkout.

CreateShipment

This service is used to start a shipment process with the shipping provider.

Request Parameters

Node Required Data Type Description
salesOrderID Yes Integer The sales order object identifier.

 

Return Data

None


GetActiveShippingMethod

This service is used to query the ShippingMethod object.

Request Parameters

Node Required Data Type Description
shippingMethodID Yes Integer The object identifier.

 

Return Data

Node Data Type Description
shippingMethod XML  
  availabilityRule XML Rule The rule to describe the conditions when the shipping is available.
  createdDate DateTime  
  displayOrder Integer  
  fallback Boolean Indicates if this shipping method only shows up if all non-fallback shipping methods are unavailable.
  name XML Locale  
  portalID Integer  
  rateRule XML Rule Shipping rate calculation rule.
  salesType Integer 1 - Direct sales, 2 - Quoted
  sellerID Integer Indicate if this object belongs to a seller.
  shippingMethodID Integer The object identifier.
  taxClassID Integer The TaxClass object identifier if this shipping method is taxable.
  universalServiceName String The globally unique name generated by the system that corresponds to the shipping gateway's service name used internally to match a real-time shipping method.
  updateDate DateTime  

 


GetActiveShippingMethods

This service is used to query all the ShippingMethod objects.

Request Parameters

Node Required Data Type Description
count No Boolean Specify if return data should include total number of records found.
skip No Integer The number of records to skip over for paging purposes.
take No Integer The number of records to return for paging purposes.

 

Return Data

Node Data Type Description
totalCount Integer Number of records found.
shippingMethods XML Container node
  shippingMethod XML Zero or more ShippingMethod nodes with same data structure as GetActiveShippingMethod service return data.

 

Comments


Powered by Revindex Wiki