API DOCUMENTATION
    Try Unleashed Now Sandbox

    Supplier Returns

    The SupplierReturns resource allows Supplier Returns to be listed and viewed. An individual Supplier Return’s details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI.

    The full range of URIs and HTTP Verbs supported are:

    Operation HTTP Action
    List a page of SupplierReturns GET /SupplierReturns/
    View a Supplier Return with the specified Guid GET /SupplierReturns/{returnGuid}
    Create a new Supplier Return POST /SupplierReturns/
    Update a Supplier Return PUT /SupplierReturns/{returnGuid}
    Delete a Supplier Return DELETE /SupplierReturns/{returnGuid}
    Complete a Supplier Return POST /SupplierReturns/{returnGuid}/Complete
    Update a Supplier Return Cost line PUT SupplierReturns/{returnGuid}/Costs/{costLineGuid}
    Update a Supplier Return Line PUT SupplierReturns/{returnGuid}/Lines/{lineGuid}
    Delete a Supplier Return Line DELETE /SupplierReturns/{returnGuid}/Lines/{lineGuid}
    Delete batch and serial numbers from a Supplier Return DELETE /SupplierReturns/{returnGuid}/ProductTracking
    Append batch and serial numbers to a Supplier Return POST /SupplierReturns/{returnGuid}/ProductTracking

    GET SupplierReturns

    Available Filters for GET Supplier Returns
    Filter Description
    endDate Returns Supplier Returns created before a specified date.
    modifiedSince Returns Supplier Returns created or edited after a specified date, must be UTC format.
    pageSize Specifies the page size for pagination. Default page size is 200 Supplier Returns.

    Note: Requesting large numbers of supplier returns can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
    purchaseOrderNumber Returns the supplier return(s) associated with the specified purchase order number.
    startDate Returns Supplier Returns created after a specified date.
    supplierCode Returns customers that start with the specific customer code.
    supplierReturnNumber Returns a single supplier return with the specified supplier return number. If set, it overrides all other filters.
    Note: Date filters should be provided in the ISO format YYYY-MM-DD.

    Filters are used by adding the filter and value to the URI:
    • /SupplierReturns?supplierCode=ACME&startDate=2012-12-31
    Available Fields for Supplier Returns
    Property Type Length
    BaseReturnCostTaxTotal Decimal
    BaseReturnCostTotal Decimal
    BaseSubTotal Decimal
    BaseTaxTotal Decimal
    BaseTotal Decimal
    Comments String 1024
    CreatedBy String 50
    CreatedOn DateTime
    Currency Currency
    ExchangeRate Nullable Decimal
    Guid Guid
    LastModifiedBy String 50
    LastModifiedOn Nullable DateTime
    PurchaseOrder PurchaseOrder
    ReturnDate Nullable DateTime
    Status String 20
    SubTotal Decimal
    Supplier Supplier
    SupplierRef String 500
    SupplierReturnCosts SupplierReturnCost Collection
    SupplierReturnLines SupplierReturnLine Collection
    SupplierReturnNumber String 20
    TaxRate Nullable Decimal
    TaxTotal Decimal
    Total Decimal
    Warehouse Warehouse
    XeroTaxCode String 50
    Available Fields for Purchase Order:
    Property Type Length
    Guid Guid
    ProductCode String 100
    ProductDescription String 500
    Available Fields for Supplier
    Property Type Length
    Guid Guid
    SupplierCode String 500
    SupplierName String 500
    Available Fields for Supplier Return Lines
    Property Type Length
    AverageLandedPriceAfterReturn Nullable Decimal
    AverageLandedPriceBeforeReturn Nullable Decimal
    Comments String 1024
    Guid Guid
    LineNumber Int
    LineTax Nullable Decimal
    OrderPrice Decimal
    OrderQuantity Decimal
    Product Product
    PurchaseUnitOrderQuantity Decimal
    PurchaseUnitReturnQuantity Decimal
    RequiredDate DateTime
    ReturnCost Decimal
    ReturnPrice Decimal
    ReturnQuantity Decimal
    ReturnReason String 25
    ReturnToSupplier Boolean
    StockOnHandBeforeReturn Nullable Decimal
    TaxRate Nullable Decimal
    XeroCostOfGoodsAccount String 500
    XeroSalesAccount String 500
    XeroTaxCode String 50
    Available Fields for Supplier Return Costs
    Property Type Length
    BCCost Decimal
    BCTaxCost Decimal
    BCTotalCost Decimal
    Cost Decimal
    CostDate DateTime
    ExchangeRate Nullable Decimal
    Guid Guid
    Refund Boolean
    Supplier Supplier
    TaxCode String 50
    TaxCost Decimal
    TaxRate Nullable Decimal
    TotalCost Decimal
    Available Fields for Currency
    Property Type Length
    CurrencyCode String 3
    Description String 200
    Guid Guid
    LastModifiedOn DateTime
    Available Fields for Product
    Property Type Length
    Guid Guid
    ProductCode String 100
    ProductDescription String 500
    Available Fields for Purchase Order
    Property Type Length
    Guid Guid
    OrderDate DateTime
    OrderNumber String 20
    Available Fields for Supplier
    Property Type Length
    Guid Guid
    SupplierCode String 500
    SupplierName String 500
    Available Fields for Warehouse
    Property Type Length
    Guid Guid
    WarehouseCode String 15
    WarehouseName String 100

    Examples for Response GET /SupplierReturns

    show xml example
    show json example

    POST SupplierReturns

    Available Fields for POST Supplier Returns
    Property Type Length Notes
    PurchaseOrder PurchaseOrder Must be an existing Purchase Order with the Complete status
    Available Fields for Purchase Order

    Note: At a minimum, a valid Guid or OrderNumber is required.

    Property Type Length
    Guid Guid
    OrderNumber String 20

    Examples for Request POST /SupplierReturns

    show xml example
    show json example

    PUT SupplierReturns

    Available Fields for PUT Supplier Returns
    Property Type Length Notes
    Comments String 1024
    Guid Guid If provided, it must match the guid provided in the URL.
    ReturnDate DateTime Must be on or after the Purchase Order's completed date.
    SupplierEORI String 20
    SupplierRef String 500
    Warehouse Warehouse
    Available Fields for Warehouse

    Note: At a minimum, a valid Guid or WarehouseCode is required.

    Property Type Length
    Guid Guid
    WarehouseCode String 15

    Examples for Request PUT /SupplierReturns

    show xml example
    show json example

    PUT Supplier Return Cost Lines

    Available Fields for Supplier Return Cost Lines
    Property Type Length Notes
    Cost Decimal
    Guid Guid If provided, it must match the costLineGuid from the request path.
    Refund Boolean

    Examples for Request PUT /SupplierReturns/{returnGuid}/Costs/{costLineGuid}

    show xml example
    show json example

    PUT SupplierReturnLines

    Available Fields for PUT Supplier Return Lines

    Note: If one of the editable fields for PUT is blank, the previous value will be overwritten with the blank value

    Property Type Length Notes
    Comments String 1024
    Guid Guid If provided, it must match the lineGuid path parameter.
    PurchaseUnitReturnQuantity Decimal
    ReturnCost Decimal
    ReturnPrice Decimal
    ReturnReason String 25 Defaults to Return.
    ReturnToSupplier Boolean

    Examples for Request PUT /SupplierReturns/{returnGuid}/Lines/{lineGuid}

    show xml example
    show json example

    POST ProductTracking

    Available Fields for POST Product Tracking
    Property Type Notes
    Guid Guid If provided, it must match the returnGuid provided in the URL.
    ProductBatches ProductBatch collection
    ProductSerials ProductSerial collection
    Available Fields for Product Batches
    Property Type Length
    Batches Batch entity
    Product Product entity
    Available Fields for Product Serials
    Property Type Length
    Product Product entity
    SerialNumbers String collection String length 50
    Available Fields for Batch
    Property Type Length
    BatchNumber String 50
    Quantity Decimal
    Available Fields for Product

    Note: At a minimum, a valid Guid or ProductCode is required.

    Property Type Length
    Guid Guid
    ProductCode String 50

    Examples for Request POST /SupplierReturns/{returnGuid}/ProductTracking

    show xml example
    show json example

    Use the API Sandbox to see how the object is rendered in JSON or XML.

    Note: An Unleashed account is required before you can use the API Sandbox.

    Trial accounts are also allowed to connect to the API.
    You can register a new account here: Register.