Entity: SalesOrder - LabelHub/labelhub.integration.documentation GitHub Wiki

SalesOrder v1

SalesOrderV1 properties

Name Type Notes
LabelHubId int Internal number for the order in LabelHub. Uniquely represents the order within LabelHub
CreatedByUser UserV1
BrandOwner BrandOwnerV1 The brandowner who placed the order within LabelHub
PurchaseOrderNumber string
RequestedDeliveryDate Date
CreatedAt DateTime
BillingAddress AddressV1 Deliveryaddress selected for this order
DeliveryAddress AddressV1 Billingaddress selected for this order
Currency string
Message string
Lines SalesOrderLineV1[]
Summary SalesOrderSummaryV1
Status string

AddressV1 properties

Name Type Notes
Name string
Company string
Contact string
Line1 string
Line2 string / null
Number string
Postcode string
City string
State string
Country string

BrandOwnerV1 properties

Name Type Notes
BrandOwnerNo string
Name string
Address string
ZipCode string
City string
Country string
OrgNo string

SalesOrderSummaryV1 properties

Name Type Notes
CreatedByUserName string
BrandOwnerName string
PriceTotal float
QuantityTotal int

SalesOrderLineV1 properties

Name Type Notes
Label SalesOrderLabelV1
Description string
Quantity int
PriceEach float
PriceUnit float
Summary SalesOrderLineSummaryV1

SalesOrderLabelV1 properties

Name Type Notes
LabelNoManufacturer string
LabelNoBrandOwner string
Description string
Status string
Shape string
Width float
Height float
CornerRadius float
LabelsAcross int
LabelsForward int
PrintMethod string
CreatedAt DateTime
StockQuantity int
NotesInternal string
NotesExternal string
Dispenser bool
MaxRollDiameter float / null

SalesOrderLineSummaryV1 properties

Name Type Notes
LabelNumberManufacturer string
LabelNumberBrandOwner string
Width float
Height float
PriceTotal float
ThumbnailUrlSmall string
ThumbnailUrlLarge string

UserV1 properties

Name Type Notes
UserId string
Name string
Email string
Title string
Phone string

Example

<?xml version="1.0" encoding="UTF-8"?>
<SalesOrder version="1"
    xmlns="http://labelhub.com/LH_1-0">
    <billingAddress>
        <name>somebilling</name>
    </billingAddress>
    <deliveryAddress>
        <name>somedelivery</name>
    </deliveryAddress>
    <brandOwner>
        <brandOwnerNo></brandOwnerNo>
        <address></address>
        <city></city>
        <country></country>
        <name>SomeBrandOwner</name>
        <zipCode></zipCode>
        <orgNo></orgNo>
    </brandOwner>
    <createdAt></createdAt>
    <currency>EUR</currency>
    <labelHubId>45</labelHubId>
    <message>My message</message>
    <purchaseOrderNumber>Some PO</purchaseOrderNumber>
    <requestedDeliveryDate></requestedDeliveryDate>
    <status>SALESORDERSTATUS_PENDING</status>
    <lines>
        <line>
            <description>DieCost</description>
            <priceEach>103</priceEach>
            <priceUnit>1</priceUnit>
            <quantity>1</quantity>
            <summary></summary>
        </line>
        <line>
            <description></description>
            <priceEach>100</priceEach>
            <priceUnit>1000</priceUnit>
            <quantity>1000</quantity>
            <summary></summary>
            <label>
                <cornerRadius></cornerRadius>
                <createdAt/>
                <description/>
                <height/>
                <labelNoBrandOwner/>
                <labelNoManufacturer/>
                <labelsAcross/>
                <labelsForward/>
                <notesExternal/>
                <notesInternal/>
                <printMethod/>
                <shape/>
                <status/>
                <stockQuantity/>
                <width/>
                <dispenser>false</dispenser>
                <maxRollDiameter/>
            </label>
        </line>
    </lines>
    <summary>
        <brandOwnerName></brandOwnerName>
        <createdByUserName></createdByUserName>
        <priceTotal>123</priceTotal>
        <quantityTotal></quantityTotal>
    </summary>
</SalesOrder>
⚠️ **GitHub.com Fallback** ⚠️