Domain > skall-studio-aps.api.webshipper.io

More information on this domain is in AlienVault OTX

DNS Resolutions

Date	IP Address
2021-05-28	34.250.202.37 (ClassC)
2026-03-01	52.209.148.215 (ClassC)

HTTP/1.1 200 OKDate: Sun, 01 Mar 2026 10:32:24 GMTContent-Type: text/html; charsetutf-8Transfer-Encoding: chunkedConnection: keep-aliveETag: W/44a08cf96d9dfaa5a3b565249620b99fCache-Control: max-age0, private, must-revalidateX-Request-Id: 349d66a7-3304-426c-a82f-d46426177bd5X-Runtime: 0.055065Vary: Origin

!DOCTYPE html>html langen>head>meta contenttext/html; charsetUTF-8 http-equivContent-Type>link hrefhttps://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/monokai.min.css relstylesheet>title>Webshipper API 2.0 Documentation/title>script crossoriginanonymous integritysha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN srchttps://code.jquery.com/jquery-3.2.1.slim.min.js>/script>script crossoriginanonymous integritysha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q srchttps://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js>/script>script crossoriginanonymous integritysha384-a5N7Y/aK3qNeh15eJKGWxsqtnX/wWdSZSKp+81YjTmS15nvnvxKHuzaWwXHDli+4 srchttps://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.3/js/bootstrap.min.js>/script>script srchttps://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js>/script>script>  hljs.initHighlightingOnLoad();/script>link href/favicon.png relshortcut icon typeimage/png>link crossoriginanonymous hrefhttps://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css integritysha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm relstylesheet>link crossoriginanonymous hrefhttps://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css integritysha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN relstylesheet>style>  @import url(https://fonts.googleapis.com/css2?familyTitillium+Web:wght@100;400;500;600&familySource+Code+Pro&familyOpen+Sans:wght@300;400;500&displayswap);  html,  body {    width: 100%; }    body {    color: #2a2c32;    font-family: Open Sans, sans-serif;    font-size: 14px;    line-height: 23px;    background-color: #0c2444;    font-variant-ligatures: none; }    h1,  h2,  h3 {    font-family: Titillium Web, sans-serif;    font-weight: bold; }    h4,  h5 {    font-family: Titillium Web, sans-serif; }    a {    color: #2a2c32;    text-decoration: underline; }    p {    letter-spacing: .01rem; }    .card {    border: none; }    ul.list-doc {    padding-bottom: 10px;    list-style: none; }    ul.list-doc li {      padding-top: 6px;      padding-bottom: 6px; }    code {    overflow-x: scroll;    max-width: 100%;    padding: 2px 5px;    color: #555;    background-color: #f0f0f0; }    .text-mono,  code {    font-family: Source Code Pro, monospace; }    .border-top {    border-top: 1px solid rgba(223, 227, 231, 0.4) !important; }    .alert {    color: white;    box-shadow: 0 3px 6px rgba(0, 0, 0, 0.16), 0 3px 6px rgba(0, 0, 0, 0.23);    border: none;    border-radius: 5px; }    .alert a {      color: white; }    .alert.alert-success {      background-color: #20c997; }    .alert.alert-info {      background-color: #0c2444; }    .text-light.text-light.text-light {    color: #9fb4be !important; }    h1 {    padding-bottom: 7px;    border-bottom: 4px solid #ddd; }    h2 {    padding-bottom: 4px;    border-bottom: 2px solid #ddd; }    h4 {    margin-top: 30px; }    h5 {    margin-top: 25px; }    .card .card-header.card-header.card-header {    background: #f1f1f1;    border-bottom: none; }    .nav-link {    text-decoration: none;    border-radius: 2px; }    .sidebar {    font-family: Titillium Web, sans-serif;    background-color: #fafafa; }    .sidebar .nav-item {      background-color: #fafafa; }    .sidebar .sidebar-header {      max-width: 200px;      padding: 2rem;      margin-bottom: 2rem; }    .sidebar a {      color: #555;      text-decoration: none; }    .sidebar .nav-pills .nav-link {      border-left: 4px solid #fafafa; }      .sidebar .nav-pills .nav-link.active {        color: #555;        background: none;        border-left: 4px solid #26ac83;        border-radius: 0; }      code {    word-break: initial;  }    pre > code {    border-radius: 3px;    word-break: break-word;  }    .hljs {    background-color: #22282e;  }    .samples .nav-link {    background-color: darkgray;    margin-right: 10px;  }/style>/head>body data-offset50 data-spyscroll data-target#sidebar>div classcontainer-fluid>div classrow>div classcol-auto sidebar ml-0 pl-0>div classsticky-top mt-0 styleheight: 100vh; overflow: scroll>div classsidebar-header>img alt classimg-fluid srcimg/logo-blue.png>/div>div stylemargin-bottom: 20px>ul classflex-column nav nav-pills>li classnav-item mb-5>a classnav-link href?download_openapi1>Download OpenAPI specification/a>/li>li classnav-item>a classnav-link href#1-introduction>1 Introduction/a>nav classml-3>a classnav-link href#1-introduction-1-1-conventions>1.1 Conventions/a>a classnav-link href#1-introduction-1-2-common-use-cases>1.2 Common Use Cases/a>a classnav-link href#1-introduction-1-3-rate-limiting>1.3 Rate limiting/a>/nav>/li>li classnav-item>a classnav-link href#2-authorisation>2 Authorisation/a>/li>li classnav-item>a classnav-link href#3-relationships>3 Relationships/a>/li>li classnav-item>a classnav-link href#4-flattened-relations>4 Flattened Relations/a>/li>li classnav-item>a classnav-link href#5-sorting-and-filtering>5 Sorting and Filtering/a>/li>li classnav-item>a classnav-link href#6-scopes>6 Scopes/a>/li>li classnav-item>a classnav-link href#7-carrier-implementation>7 Carrier implementation/a>/li>li classnav-item>a classnav-link href#8-webshipper-expression-language>8 Webshipper Expression Language/a>/li>li classnav-item>a classnav-link href#9-webshipper-template-language>9 Webshipper Template Language/a>/li>/ul>hr>ul classflex-column nav nav-pills>li classnav-item mb-2>small classnav-link text-uppercase>Primary Resources/small>/li>ul classflex-column nav nav-pills mb-4 ml-2>li classnav-item>a classnav-link href#drop_point_locators>Drop Point Locator/a>/li>li classnav-item>a classnav-link href#orders>Order/a>/li>li classnav-item>a classnav-link href#packages>Package/a>/li>li classnav-item>a classnav-link href#rate_quotes>Rate Quote/a>/li>li classnav-item>a classnav-link href#service_quotes>Service Quote/a>/li>li classnav-item>a classnav-link href#shipments>Shipment/a>/li>li classnav-item>a classnav-link href#webhooks>Webhook/a>/li>/ul>li classnav-item mb-2>small classnav-link text-uppercase>All Resources/small>/li>ul classflex-column nav nav-pills mb-4 ml-2>li classnav-item>a classnav-link href#brands>/a>/li>li classnav-item>a classnav-link href#return_refund_methods>/a>/li>li classnav-item>a classnav-link href#actions>Action/a>/li>li classnav-item>a classnav-link href#activities>Activity/a>/li>li classnav-item>a classnav-link href#activity_types>Activity Types/a>/li>li classnav-item>a classnav-link href#additional_attributes>Additional Attribute/a>/li>li classnav-item>a classnav-link href#attachments>Attachment/a>/li>li classnav-item>a classnav-link href#automations>Automation/a>/li>li classnav-item>a classnav-link href#automations_dry_runs>Automations Dry Run/a>/li>li classnav-item>a classnav-link href#barcode_ranges>Barcode Range/a>/li>li classnav-item>a classnav-link href#bulk_import_orders>Bulk import orders/a>/li>li classnav-item>a classnav-link href#csv_mappings>CSV Mapping/a>/li>li classnav-item>a classnav-link href#csv_rules>CSV Mapping Rule/a>/li>li classnav-item>a classnav-link href#csv_uploads>CSV Upload/a>/li>li classnav-item>a classnav-link href#carriers>Carrier/a>/li>li classnav-item>a classnav-link href#carrier_accesses>Carrier Access/a>/li>li classnav-item>a classnav-link href#carrier_types>Carrier Type/a>/li>li classnav-item>a classnav-link href#comments>Comment/a>/li>li classnav-item>a classnav-link href#customs_lines>Customs Line/a>/li>li classnav-item>a classnav-link href#documents>Document/a>/li>li classnav-item>a classnav-link href#document_templates>Document Templates/a>/li>li classnav-item>a classnav-link href#drop_points>Drop Point/a>/li>li classnav-item>a classnav-link href#drop_point_locators>Drop Point Locator/a>/li>li classnav-item>a classnav-link href#edis>EDI/a>/li>li classnav-item>a classnav-link href#end_of_day_reports>End-of-day report/a>/li>li classnav-item>a classnav-link href#error_types>Error Type/a>/li>li classnav-item>a classnav-link href#events>Event/a>/li>li classnav-item>a classnav-link href#event_models>EventModel/a>/li>li classnav-item>a classnav-link href#favourite_pages>Favourite Page/a>/li>li classnav-item>a classnav-link href#has_documents>Has Documents/a>/li>li classnav-item>a classnav-link href#hot_keys>HotKey/a>/li>li classnav-item>a classnav-link href#labels>Label/a>/li>li classnav-item>a classnav-link href#local_attrs>Local Attribute/a>/li>li classnav-item>a classnav-link href#local_attr_enums>Local Attribute Enums/a>/li>li classnav-item>a classnav-link href#mail_template_previews>Mail Template Preview/a>/li>li classnav-item>a classnav-link href#mail_templates>Mail Templates/a>/li>li classnav-item>a classnav-link href#order_merges>Merged Order/a>/li>li classnav-item>a classnav-link href#pdf_merges>Merged PDF/a>/li>li classnav-item>a classnav-link href#models>Model/a>/li>li classnav-item>a classnav-link href#oauth_access_tokens>OAuth Access Token/a>/li>li classnav-item>a classnav-link href#oauth_applications>OAuth Application/a>/li>li classnav-item>a classnav-link href#orders>Order/a>/li>li classnav-item>a classnav-link href#order_channels>Order Channel/a>/li>li classnav-item>a classnav-link href#order_channel_accesses>Order Channel Access/a>/li>li classnav-item>a classnav-link href#order_channel_types>Order Channel Type/a>/li>li classnav-item>a classnav-link href#order_lines>Order Line/a>/li>li classnav-item>a classnav-link href#packages>Package/a>/li>li classnav-item>a classnav-link href#pickups>Pickup/a>/li>li classnav-item>a classnav-link href#bulk_printer_jobs>Print Bulk Slips/a>/li>li classnav-item>a classnav-link href#printables>Printable/a>/li>li classnav-item>a classnav-link href#printers>Printer/a>/li>li classnav-item>a classnav-link href#printer_clients>Printer Client/a>/li>li classnav-item>a classnav-link href#printer_jobs>Printer Job/a>/li>li classnav-item>a classnav-link href#rate_quotes_items>Quote Object/a>/li>li classnav-item>a classnav-link href#rate_quotes>Rate Quote/a>/li>li classnav-item>a classnav-link href#reports>Report/a>/li>li classnav-item>a classnav-link href#report_types>Report Type/a>/li>li classnav-item>a classnav-link href#printer_requeue_jobs>Requeueable Printer Jobs/a>/li>li classnav-item>a classnav-link href#return_causes>Return Causes/a>/li>li classnav-item>a classnav-link href#return_lines>Return Lines/a>/li>li classnav-item>a classnav-link href#returns>Return Order/a>/li>li classnav-item>a classnav-link href#return_portals>Return Portal/a>/li>li classnav-item>a classnav-link href#return_shipping_methods>Return Shipping Method/a>/li>li classnav-item>a classnav-link href#service_quotes>Service Quote/a>/li>li classnav-item>a classnav-link href#shipments>Shipment/a>/li>li classnav-item>a classnav-link href#shipping_addresses>Shipping Address/a>/li>li classnav-item>a classnav-link href#shipping_mappings>Shipping Mapping/a>/li>li classnav-item>a classnav-link href#shipping_rates>Shipping Rate/a>/li>li classnav-item>a classnav-link href#expressions>Shipping Rate Expression/a>/li>li classnav-item>a classnav-link href#regions>Shipping Region/a>/li>li classnav-item>a classnav-link href#slip_templates>Slip Template/a>/li>li classnav-item>a classnav-link href#slip_template_previews>Slip Template Preview/a>/li>li classnav-item>a classnav-link href#stores>Store/a>/li>li classnav-item>a classnav-link href#tags>Tag/a>/li>li classnav-item>a classnav-link href#tracking_events>Tracking Event/a>/li>li classnav-item>a classnav-link href#triggers>Trigger/a>/li>li classnav-item>a classnav-link href#users>User/a>/li>li classnav-item>a classnav-link href#user_groups>User Group/a>/li>li classnav-item>a classnav-link href#waybills>Waybill/a>/li>li classnav-item>a classnav-link href#webhooks>Webhook/a>/li>li classnav-item>a classnav-link href#webhook_failures>Webhook Failure/a>/li>/ul>/ul>/div>/div>/div>div classcol styleoverflow-x: hidden>div classrow>div classcol-md-6 bg-white>div classpy-5>/div>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id1-introduction>h1>1 Introduction/h1>div>h4 id1-introduction-1-1-conventions>1.1 Conventions/h4>  p>    The Webshipper API is a RESTful JSON API that gives full control over your Webshipper account. The API is scoped to your em>account name/em>,    and is accessed via the endpoint em>https://<account name>.api.webshipper.io/v2//em>. Your em>account name/em> is the same as you see when you access the Webshipper web UI    at em>https://<account name>.webshipper.io/em>.  /p>  p>    This API conforms to the a hrefhttp://jsonapi.org/>JSON API standard/a> with the following conventions:    ul>      li>Resources are identified with the attribute code>id/code>, which is a server-side generated sequential integer/li>      li>Resource types are pluralised and underscored, like code>order_lines/code>/li>      li>The API has a fixed page limit of 30 records. To fetch more records use the query parameter code>pagenumber/code>/li>      li>All resources have the attributes code>created_at/code> and code>updated_at/code> which are ISO 8601 timestamps like code>2018-03-07T14:01:18.000Z/code> /li>      li>All country codes are a hrefhttps://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>ISO 3166-1 alpha-2/a> codes/li>    /ul>  /p>  p> It is also possible to download the documentation in the OpenAPI 3.0 a href?download_openapi1>here/a> /p>  div classalert alert-info>    i classfa fa-info mr-2>/i>    Webshipper em>strongly/em> recommends using a client library for utilising this API. Refer to jsonapi.orgs list of    a hrefhttp://jsonapi.org/implementations/#client-libraries>jsonapi.orgs list of client libraries/a> to find one for your language.  /div>h4 id1-introduction-1-2-common-use-cases>1.2 Common Use Cases/h4>h5>Creating an Order with Drop Point/h5>p>/p>div classcard bg-light mb-4>  div classcard-header>strong>    Example of an Order  /strong>/div>  div classcard-body>    div classbadge badge-success>POST/div> https://<account name>.api.webshipper.io/v2/orders    pre>code langjson>{  data: {    type: orders,    attributes: {      drop_point: {        drop_point_id: 12,        address_1: Street 123,        zip: 8600,        city: Silkeborg,        country_code: DK,        carrier_code: DUMMY      },      delivery_address: {        address_1: Lyngbygade 8,        zip: 8600,        city: Silkeborg,        country_code: DK      },      sender_address: {        address_1: Example street 2,        zip: 7400,        city: Herning,        country_code: DK      },      order_lines:         {          sku: ZB420,          description: Zebra GK420d label printer,          quantity: 1,          location: LOC 3563-67,          tarif_number: 844332,          country_of_origin: DK,          unit_price: 24.0,          vat_percent: 25.0,          order_id: 12,          status: null,          ext_ref: 342342,          weight: 500.0,          weight_unit: g,          discount_value: 0.0,          discount_type: fixed,          discounted_unit_price: 24.0        }          },    relationships: {      order_channel: {        data: {          id: 9,          type: order_channels        }      },      shipping_rate: {        data: {          id: 6,          type: shipping_rates        }      }    }  }}    /code>/pre>  /div>/div>h5>Quoting for Services/h5>p>  Service Quotes provides a way to quote carriers directly to find a set of suitable services./p>div classcard bg-light mb-4>  div classcard-header>strong>    Example a Service Quote  /strong>/div>  div classcard-body>    p>      Assuming a Carrier exists with id 1.    /p>    div classbadge badge-success>POST/div> https://<account name>.api.webshipper.io/v2/service_quotes    pre>code langjson>{  data: {    type: service_quotes,    attributes: {      carrier_id: 1,      send_time: 2018-04-03T10:19:53.9+01:00,      sender_address: {        address_1: Lyngbygade 8,        zip: 8600,        city: Silkeborg,        country_code: DK      },      delivery_address: {        address_1: Lyngbygade 8,        zip: 9190,        city: Tromsø,        country_code: NO      }    }  }}    /code>    /pre>    p>Expected response/p>    pre>code langjson>{    data: {        id: 1,        type: service_quotes,        links: {            self: http://you.api.webshipper.io/v2/service_quotes/1        },        attributes: {            carrier_id: 1,            packages: null,            send_time: 2018-04-03T10:19:53.9+01:00,            sender_address: {                address_1: Lyngbygade 8,                zip: 8600,                city: Silkeborg,                country_code: DK            },            delivery_address: {                address_1: Lyngbygade 8,                zip: 9190,                city: Tromsø,                country_code: NO            },            items: null,            services:                 {                    service_name: MyPack Home,                    service_code: MYPACK_HOME,                    is_return: false,                    supports_paperless: false,                    requires_drop_point: false,                    cost_price: null,                    currency: null,                    vat_percent: null,                    estimated_delivery_date_from: null,                    estimated_delivery_date_to: null,                    add_ons:                         {                            add_on_name: Pakke med omtanke,                            add_on_code: Z22                        },                        {                            add_on_name: Flexlevering,                            add_on_code: Z41                        },                        {                            add_on_name: Transportforsikring i Europa,                            add_on_code: Z60                        }                    ,                    parameters: null,                    country_combinations:                         {                            sender_country: DK,                            recipient_countries:                                 NO                                                    }                    ,                    barcode_requirement: {                        barcode_type: SSCC,                        scope: global                    },                    waybill_requirement: null,                    booking_quote_info: null                },                {                    service_name: Storbrev,                    service_code: STORBREV,                    is_return: false,                    supports_paperless: false,                    requires_drop_point: false,                    cost_price: null,                    currency: null,                    vat_percent: null,                    estimated_delivery_date_from: null,                    estimated_delivery_date_to: null,                    add_ons: null,                    parameters: null,                    country_combinations:                         {                            sender_country: DK,                            recipient_countries:                                 EE,                                FI,                                FR,                                GR,                                IE,                                IS,                                IT,                                HR,                                LV,                                LT,                                LU,                                NL,                                NO,                                AF,                                PL,                                PT,                                CH,                                SK,                                SI,                                ES,                                GB,                                SE,                                CZ,                                DE,                                HU,                                AT                                                    }                    ,                    barcode_requirement: {                        barcode_type: LZ,                        scope: local                    },                    waybill_requirement: null,                    booking_quote_info: null                }                    },        meta: {            copyright: © 2018 Webshipper ApS        }    }}/code>/pre>  /div>/div>h5>Quoting an Order Channel for Shipping Rates/h5>p>  Order Channel Rate Quotes can quote an order channel for matching shipping rates. These quotes are used to display shipping options in e-commerce systems./p>div classcard bg-light mb-4>  div classcard-header>    strong>Quoting Shipping Rates/strong>  /div>  div classcard-body>    p>      Request:    /p>    div classbadge badge-success>POST/div> https://<account name>.api.webshipper.io/v2/rate_quotes    pre>code classjson> {  data: {    type: rate_quotes,    attributes: {      order_channel_id: 16,      price: 199,      weight: 100,      delivery_address: {        zip: 7400,        country_code: DK      },      items:         {          quantity: 5,          sku: sku123        }          }  }}    /code>/pre>    p>Response/p>    pre>code classjson>{  data: {    id: 1,    type: rate_quotes,    links: {      self: /v2/rate_quotes/1    },    attributes: {      quotes:         {          price: 45,          tax_percent: 0,          currency: EUR,          carrier_logo: data:image/png;base64,iVBORw...,          carrier_name: PostNord,          shipping_rate: {            id: 16,            order_channel_id: 16,            carrier_id: 4,            name: Levering til døren,            carrier_service_code: MYPACK_HOME,            zip_policy: null,            require_drop_point: false,            visible_for: null,            created_at: 2018-03-19 10:15:27 UTC,            updated_at: 2018-04-06 09:06:13 UTC,            is_return: false,            carriers_email: false,            carriers_sms: false,            mail_template_id: null,            comment_map: {{order.external_comment}},            reference_map: O{{order.id}},            dutiable: null          }        },        {          price: 0,          tax_percent: 0,          currency: EUR,          carrier_logo: data:image/png;base64,iVBORw0KGgo....,          carrier_name: Your GLS ,          shipping_rate: {            id: 17,            order_channel_id: 16,            carrier_id: 2,            name: GLS Pakkeshop,            carrier_service_code: PARCELSHOP,            zip_policy: null,            require_drop_point: true,            visible_for: null,            created_at: 2018-03-19 12:57:36 UTC,            updated_at: 2018-03-19 12:57:36 UTC,            is_return: false,            carriers_email: true,            carriers_sms: true,            mail_template_id: null,            comment_map: {{order.external_comment}},            reference_map: O{{order.id}},            dutiable: null          }        }      ,      success: true,      delivery_address: {        zip: 7400,        country_code: DK      },      price: 199,      weight: 100,      height: null,      length: null,      width: null,      sender_address: null,      items:         {          quantity: 5,          sku: sku123        }      ,      order_channel_id: 16    },    meta: {      copyright: © 2018 Webshipper ApS    }  }}    /code>/pre>  /div>/div>h5>Creating Shipments without an Order/h5>p>  The Webshipper API can be used as a shipping engine for booking shipments and automatically printing labels.  Shipments can be created with or without having created an Order first./p>div classcard bg-light mb-4>  div classcard-header>strong>    Example of creating a new Shipment without an Order  /strong>/div>  div classcard-body>    p>      Assuming a Carrier exists with id 1 and that it provides a service called code>MYPACK_HOME/code>    /p>    div classbadge badge-success>POST/div> https://<account name>.api.webshipper.io/v2/shipments    pre>code langjson>{  data: {    type: shipments,     attributes: {        reference: ref65436,        service_code: MYPACK_HOME,        packages:           {            weight: 1000,            weight_unit: g,            customs_lines:               {                sku: SKU1,                description: Black pants,                quantity: 1,                tarif_number: 234343332,                country_of_origin: DE,                unit_price: 15,                vat_percent: 15.0,                currency: EUR,                weight: 1000,                weight_unit: g              }            ,            dimensions: {              height: 15,              width: 15,              length: 15,              unit: cm            }          }        ,        delivery_address: {          company_name: Webshipper ApS,          address_1: lyngbygade 8,          zip: 8600,          city: Silkeborg,          country_code: DK,          email: invoice@webshipper.com,          address_type: recipient        },        sender_address: {          company_name: Webshipper ApS,          address_1: lyngbygade 8,          zip: 8600,          city: Silkeborg,          country_code: DK,          email: invoice@webshipper.com,          address_type: recipient        }    },    relationships: {      carrier: {        data: {id: 1, type: carriers}      }    }  }}/code>/pre>  /div>/div>h5>Creating a Shipment from an Order/h5>p>/p>div classcard bg-light mb-4>  div classcard-header>strong>    Example of creating a Shipment from an Order  /strong>/div>  div classcard-body>    p>Assumes an order exists with id 1 /p>    div classbadge badge-success>POST/div> https://<account name>.api.webshipper.io/v2/shipments    pre>code classjson>{  data: {    type: shipments,    attributes: {    },    relationships: {      order: {        data: {id: 1, type: orders}      }    }  }}/code>/pre>  /div>/div>h5>Creating a Shipment from a Shipping Rate/h5>p>/p>div classcard bg-light mb-4>  div classcard-header>strong>    Example of creating a Shipment from an Order  /strong>/div>  div classcard-body>    p>Assumes a Shipping Rate exists with id 1 and requires a drop point/p>    div classbadge badge-success>POST/div> https://<account name>.api.webshipper.io/v2/shipments    pre>code classjson>{  data: {    type: shipments,    attributes: {    sender_address: {        company_name: Webshipper,        address_1: Lyngbygade 8,        zip: 8600,        city: Silkeborg,        country_code: DK      },      delivery_address: {        att_contact: Guy McPerson,        address_1: Dummystreet 123,        zip: 7430,        city: Ikast,        country_code: DK      },      drop_point: {        name: PostNord Drop Point 2,        address_1: Nørreallé 12,        zip: 7430,        city: Ikast,        country_code: DK      },      packages:       {        weight: 1000,        weight_unit: g      }          },    relationships: {      shipping_rate: {        data: {id: 1, type: shipping_rates}      }    }  }}/code>/pre>  /div>/div>h5>Searching Drop Points/h5>p>Search for the nearest drop points by carrier using code>drop_point_locators/code>./p>div classcard bg-light mb-4>  div classcard-header>strong>    Example of searching drop points  /strong>/div>  div classcard-body>    p>    /p>    span classbadge badge-success>POST/span> https://<account name>.api.webshipper.io/v2/drop_point_locators    pre>code classjson>{  data: {    type: drop_point_locators,    attributes: {      carrier_id: 1,      service_code: MYPACK_COLLECT,      delivery_address: {        address_1: Lynbgbygade 8,        city: Silkeborg,        zip: 7400,        country_code: DK      }    }  }}      /code>    /pre>    p>Response/p>    pre>code classjson>{    data: {        id: 1,        type: drop_point_locators,        links: {            self: http://mads.api.staging.webshipper.io/v2/drop_point_locators/1        },        attributes: {            carrier_id: 4,            service_code: MYPACK_COLLECT,            shipping_rate_id: null,            delivery_address: {                address_1: Lynbgbygade 8,                city: Silkeborg,                zip: 8600,                country_code: DK            },            drop_points:                 {                    name: Posthus Superbrugsen,                    longitude: 9.51366,                    latitude: 56.1849,                    address_1: Øster Bordingvej 1,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 8603,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:36.000Z,                    updated_at: 2018-04-10T11:08:48.000Z,                    routing_code: null                },                {                    name: Pakkeboks 5143 Fakta,                    longitude: 9.49539,                    latitude: 56.1719,                    address_1: Padborgvej 298,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 5143,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:40.000Z,                    updated_at: 2018-04-10T11:09:00.000Z,                    routing_code: null                },                {                    name: Pakkeboks 3947 Fakta,                    longitude: 9.57671,                    latitude: 56.1881,                    address_1: Randersvej 12,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 3947,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:40.000Z,                    updated_at: 2018-04-10T11:09:00.000Z,                    routing_code: null                },                {                    name: Pakkeboks 3842 Super Brugsen,                    longitude: 9.51366,                    latitude: 56.1849,                    address_1: Øster Bordingvej 1,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 3842,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:53.000Z,                    updated_at: 2018-04-10T11:09:37.000Z,                    routing_code: null                },                {                    name: Posthus Spar,                    longitude: 9.62954,                    latitude: 56.2267,                    address_1: Grønbækvej 9,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 8607,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:41.000Z,                    updated_at: 2018-04-10T11:09:03.000Z,                    routing_code: null                },                {                    name: Posthus Lokalbrugsen,                    longitude: 9.40918,                    latitude: 56.1947,                    address_1: Engesvangvej 9,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 8604,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:41.000Z,                    updated_at: 2018-04-10T11:09:03.000Z,                    routing_code: null                },                {                    name: Pakkeboks 340 V/ Silkeborg Station,                    longitude: 9.54492,                    latitude: 56.1646,                    address_1: Drewsensvej 5,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 340,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:41.000Z,                    updated_at: 2018-04-10T11:09:03.000Z,                    routing_code: null                },                {                    name: Posthus Føtex,                    longitude: 9.54973,                    latitude: 56.1692,                    address_1: Torvet 4,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 8605,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:53.000Z,                    updated_at: 2018-04-10T11:09:38.000Z,                    routing_code: null                },                {                    name: Pakkeboks 3946 Kvickly,                    longitude: 9.55464,                    latitude: 56.1729,                    address_1: Søtorvet 1,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 3946,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:50.000Z,                    updated_at: 2018-04-10T11:09:28.000Z,                    routing_code: null                },                {                    name: Posthus Kvickly,                    longitude: 9.55464,                    latitude: 56.1729,                    address_1: Søtorvet 1,                    address_2: null,                    zip: 8600,                    city: Silkeborg,                    country_code: DK,                    state: null,                    phone: null,                    drop_point_id: 8601,                    carrier_code: POSTNORD,                    created_at: 2018-04-04T12:49:46.000Z,                    updated_at: 2018-04-10T11:09:18.000Z,                    routing_code: null                }                    },        meta: {            copyright: © 2018 Webshipper ApS        }    }}    /code>/pre>  /div>/div>h4 id1-introduction-1-3-rate-limiting>1.3 Rate limiting/h4>p>The Webshipper API has a rate limiter. It is implemented with a leaky bucket algoritm, which allows you to make up to 2 API calls per second with a bucket size of 40. In other words you are able to make infrequent bursts and if you keep API calls below 2 calls per second, you wont ever be restricted. The rate limit is scoped per token./p>p>In case you need to have this limit increased, please contact your Webshipper sales representative./p>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id2-authorisation>h1>2 Authorisation/h1>div>strong>If you want to get started as fast as possible - you can create an access token from the UI under Settings > Access and tokens./strong>br>br>p>  The API uses a hrefhttps://tools.ietf.org/html/rfc6749>OAuth2/a> for authorization.  The following grant_types are supported by the API:/p>ul>  li>Resource Owner Password Credentials. Obtain an access token with a username and password. Tokens issued with this grant type will always have same scopes as the users group  /li>  li>    Authorization Code Grant. Authorise an application to access the users account data using a web based form.  /li>  li>    Implicit Grant. Used in cases where the client cannot be trusted  /li>/ul>p>  Please see the a hrefhttps://tools.ietf.org/html/rfc6749>OAuth2 specification/a> for more details or read  a hrefhttps://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2>DigitalOceans guide on    OAuth2/a>./p>p>  The attributes client_id and client_secret are not used with the password grant_type./p>div classcard bg-light mb-4>  div classcard-header>strong>    Requesting a token using username and password  /strong>/div>  div classcard-body>    pre>code langbash>curl -X POST https://<account name>.api.webshipper.io/v2/      oauth/token\?grant_typepassword\&usernameuser@example.com&passwordmuchs2cret/code>/pre>    p>Response:/p>    pre>code langjson>{   access_token:4f6e6c041914116a30b5cdd16fda38db43d24327fa841e005d20b26074dedd81,   token_type:bearer,   expires_in:3599,   refresh_token:c6ea647e6a99fd568fa4907469c763ae631f3aeab11ebb5c9317000bf9f06873,   scope:read_orders read_shipments,   created_at:1515749820}/code>/pre>  /div>/div>p>  Authorised requests to Webshipper are made by setting the code>Authorization/code> header. Example:/p>div classcard bg-light mb-4>  div classcard-header>strong>    Making Authorised Requests  /strong>/div>  div classcard-body>    pre>code langbash>curl -H Authorization: Bearer <token> https://<account name>.api.webshipper.io/v2/orders/code>/pre>  /div>/div>p>  Most tokens are issued with a code>refresh_token/code>. This is used to obtain a new access token./p>div classcard bg-light mb-4>  div classcard-header>strong>    Using Refresh tokens  /strong>/div>  div classcard-body>    pre>code langbash>curl -X POST https://<account name>.api.webshipper.io/v2/oauth/token\?grant_typerefresh_token\&refresh_token<refresh_token>/code>/pre>    p>Response:/p>    pre>code langjson>{   access_token:9bfc1c29a1820481ea56b72d61964b5863f2a7151e011a450f543916d5787a09,   token_type:bearer,   expires_in:3599,   refresh_token:2b3c5a3504432ae6c5ea2844b6de3c8c6492991a666e93a48310259bc57e3374,   scope:read_orders read_shipments,   created_at:1515751219}/code>/pre>  /div>/div>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id3-relationships>h1>3 Relationships/h1>div>p>  Most entities have relationships that can be sideloaded. To see which relationships an entity has, please look at the relationships part of any given GET request or look at the entity in this documentation./p>p>  When you GET a resource you can request to include relationships by addding code>?include(resource_name)/code> to the query./p>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id4-flattened-relations>h1>4 Flattened Relations/h1>div>p>Some relations are em>flattened/em>, i.e. not using the JSON API relationships, but present them as simple JSON objects in the attributes/p>p> Flattened relations are replaced for each em>update/em> operation if the em>id/em> attribute is not present.  If em>id/em> is given the relation is updated./p>div classalert alert-info>  i classfa fa-info mr-2>/i>  In most use cases, the em>id/em> attribute can be ignored./div>div classcard bg-light mb-4>  div classcard-header>strong>    Example of updating OrderLines of an Order  /strong>/div>  div classcard-body>    p>One order line is updated and one is added, this is useful for preserving relations to e.g. packages./p>    div classbadge badge-secondary>PATCH/div> https://<account name>.api.webshipper.io/v2/orders/12    pre>code classjson>{  data: {    id: 12,    type: orders,    attributes: {      order_lines:         {          id: 23,          sku: sk1231,        },        {          sku: sk853,          description: Black Hat, good for putting on your head        }          }  }}/code>/pre>  /div>/div>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id5-sorting-and-filtering>h1>5 Sorting and Filtering/h1>div>p>  As the JSON API is agnostic about filtering strategies the following conventions are used:  ul>    li>Simple filtering with strict equality () can by done with the code>filternameWebshipper/code>/li>    li>Advanced filtering can be done by providing a list of objects to  code>filtername/code>. Example: code>filternamevalueWebshipper&filternameoperator%3D/code> (%3D is the url encoding of ). The following operators are supported:      code>!/code>, code>/code>, code></code>, code></code>, code>>/code>, code>>/code>, code>LIKE/code>, code>NOT LIKE/code>. Operators share the semantics as their SQL counterparts, e.g. you can do fuzzy search like      code>filtercityvalueAarhus%25&filtercityoperatorLIKE/code> to find addresses where the city begins with Aarhus    /li>  /ul>/p>p classmt-4>  Return all pending orders:br>  code>    {tenant}.api.webshipper.io/v2/orders?filterstatuspending  /code>/p>p classmt-5>  Some resources do not follow this convention or have additional filter for things like customised search or filtering by associated resources./p>h5>Advanced filtering/h5>p>  If you want to get all orders with status code>pending/code> or code>dispatched/code>, it can simply be achived by comma-separating the filter value.br>br>  So it will look like this:br>  code>    /v2/orders?filterstatuspending,dispatched  /code>/p>p classmt-4>  Another advanced filter example could be to fetch all orders created between two dates.br>  To do that, you need to use the explicit method of defining filters, with seperate code>value/code> and code>operator/code>.br>  Furthermore, the code>name/code> (eg. code>created_at/code>) needs to be forced into an array structure like this code>created_at0value/code>br>br>  So it will look like this:br>  code>    /v2/orders?filtercreated_at0operator%3C%3D&filtercreated_at0value2021-03-29&filtercreated_at1operator%3E%3D&filtercreated_at1value2021-03-26  /code>  br>  Note the addition of code>0/code> and code>1/code>./p>p classmt-4>  Both those advanced filters can be merged together, so if you want to get all orders with status code>dispatch/code> or code>pending/code>, which was created between code>2021-03-29/code> and code>2021-03-26/code>, it will look like this:br>  code>    /v2/orders?filterstatuspending,dispatched&filtercreated_at0operator%3C%3D&filtercreated_at0value2021-03-29&filtercreated_at1operator%3E%3D&filtercreated_at1value2021-03-26  /code>/p>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id6-scopes>h1>6 Scopes/h1>div>ul>  li>code>read_orders/code>/li>  li>code>write_orders/code>/li>  li>code>read_shipments/code>/li>  li>code>write_shipments/code>/li>  li>code>read_rates/code>/li>  li>code>write_rates/code>/li>  li>code>read_order_channels/code>/li>  li>code>write_order_channels/code>/li>  li>code>read_carries/code>/li>  li>code>write_carriers/code>/li>  li>code>read_templates/code>/li>  li>code>write_templates/code>/li>  li>code>read_carrier_types/code>/li>  li>code>read_order_channel_types/code>/li>  li>code>read_user_groups/code>/li>  li>code>read_slip_templates/code>/li>  li>code>write_slip_templates/code>/li>  li>code>read_mail_templates/code>/li>  li>code>write_mail_templates/code>/li>  li>code>read_users/code>/li>  li>code>write_users/code>/li>  li>code>read_order_channel_acls/code>/li>  li>code>write_order_channel_acls/code>/li>  li>code>write_carrier_acls/code>/li>  li>code>read_carrier_acls/code>/li>  li>code>read_printers/code>/li>  li>code>write_printers/code>/li>  li>code>read_barcode_ranges/code>/li>  li>code>write_barcode_ranges/code>/li>  li>code>read_access_tokens/code>/li>  li>code>write_access_tokens/code>/li>  li>code>read_reports/code>/li>  li>code>write_reports/code>/li>  li>code>read_waybills/code>/li>  li>code>write_waybills/code>/li>  li>code>read_shipping_addresses/code>/li>  li>code>write_shipping_addresses/code>/li>/ul>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id7-carrier-implementation>h1>7 Carrier implementation/h1>div>p>This section has been removed and is no longer available/p>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id8-webshipper-expression-language>h1>8 Webshipper Expression Language/h1>div>p>The Webshipper Expression Language (WEL) is an expression language created by Webshipper for the purpose of writing highly customisable matchers.WEL expressions are used for finding the correct price for a Shipping Rate as well as for triggering automations. WEL expressions are given JSON-like objects as input./p>div classcard bg-light>div classcard-header>strong>Example of WEL expressions/strong>/div>div classcard-body>p>If this expressionpre>code>(delivery_address.country_code  NO and weight in 1000-2000 and not (sender_address.zip in 1000-5000) and price > 200 ) or (packages.count > 2)/code>/pre>Is given the following input:pre>code>{
  weight: 1100,
  delivery_address: {
    zip: 10200,
    country_code: NO
  },
  sender_address: {
    zip: 8000,
    country_code: DK
  },
  packages: 
    {
      weight: 500
    },
    {
      weight: 600
    }
  
}/code>/pre>It will evaluate to true./p>/div>/div>div classcard bg-light mt-3>div classcard-header>strong>Webshipper Expression Language Syntax/strong>/div>div classcard-body>Expressions have the following syntax, where code>x/code> and code>y/code> are any WEL expressionstable classtable>thead>tr>th>Syntax/th>th>Example/th>/tr>/thead>tbody>tr>td>code>12/code>/td>td>/td>/tr>tr>td>code>12.0/code>/td>td>/td>/tr>tr>td>code>String literal/code>/td>td>/td>/tr>tr>td>code>true/code>/td>td>code>order.order_lines all is_virtual  true/code>/td>/tr>tr>td>code>false/code>/td>td>code>order.order_lines any is_virtual  false/code>/td>/tr>tr>td>code>x and y/code>/td>td>code>delivery_address.country_code  DK and weight  > 1000/code>/td>/tr>tr>td>code>x or y/code>/td>td>code>delivery_address.country_code  DK or weight  > 1000/code>/td>/tr>tr>td>code>x  y/code>/td>td>code>delivery_address.country_code  DK/code>/td>/tr>tr>td>code>x like y/code>/td>td>code>delivery_address.sku like Loc123-/code>/td>/tr>tr>td>code>x > y/code>/td>td>code>weight  > 1000/code>/td>/tr>tr>td>code>x < y/code>/td>td>code>weight  < 1000/code>/td>/tr>tr>td>code>x > y/code>/td>td>code>weight > 1000/code>/td>/tr>tr>td>code>x < y/code>/td>td>code>weight < 1000/code>/td>/tr>tr>td>code>( x )/code>/td>td>code>delivery_address.country_code  DK and (weight < 10 or weight > 100)/code>/td>/tr>tr>td>code>x in i-j/code>, where i and j are integers/td>td>code>delivery_address.zip in 3000-9999/code>/td>/tr>tr>td>code>not x/code>/td>td>code>not (delivery_address.county_code  DK)/code>/td>/tr>tr>td>code>x.count/code>/td>td>code>order.order_lines.count/code>/td>/tr>tr>td>code>x.some_allowed_attribute/code>/td>td>code>order.visible_ref/code>/td>/tr>tr>td>code>x any y/code>/td>td>code>order.order_lines any sku  1245/code>/td>/tr>tr>td>code>x all y/code>/td>td>code>order.order_lines all is_virtual  true/code>/td>/tr>tr>td>code>x present?/code>/td>td>code>order.drop_point present?/code>/td>/tr>tr>td>code>x in a, b, c/code>/td>td>code>order.order_lines any sku in 213, 543, 978/code>/td>/tr>/tbody>/table>/div>/div>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white px-5 pb-5>div id9-webshipper-template-language>h1>9 Webshipper Template Language/h1>div>p>The Webshipper Template Language (WTL) is a template language created by Webshipper for the purpose of designing e-mail templates for tracking notifications and parcel slips. WTL may be utilised through several different mechanisms, such as placeholders, conditions etc./p>div classcard bg-light>div classcard-header>strong>Placeholders/strong>/div>div classcard-body>p>Placeholders make it possible to insert dynamic data. Data may be inserted by accessing objects inside curly brackets. For example, a shipment object is available for tracking mails and it may be used as follows:pre>code>Order {{shipment.reference}}/code>/pre>/p>/div>div classcard bg-light mt-3>div classcard-header>strong>Conditions/strong>/div>div classcard-body>p>Conditions allow you to render content conditionally, this may be done through if-conditions as follows:pre>code>{% if order.order_channel_id  1 or order.visible_ref contains SHOP1 %} This is order channel 1{% else %} This is not order channel 1{% endif %}/code>/pre>The following operators are supported for conditions:table classtable mt-2>thead classthead-light>tr>th>Operator/th>th>Function/th>/tr>/thead>tbody>tr>th>/th>td>equals/td>/tr>tr>th>!/th>td>not equals/td>/tr>tr>th>>/th>td>greater than/td>/tr>tr>th>/th>td>less than/td>/tr>tr>th>/th>td>less than or equal/td>/tr>tr>th>>/th>td>greater than or equal/td>/tr>tr>th>or/th>td>Condition A or condition B/td>/tr>tr>th>and/th>td>Condition A and condition B/td>/tr>/tbody>/table>/p>/div>div classcard bg-light mt-3>div classcard-header>strong>Iteration/strong>/div>div classcard-body>p>You may iterate through collections using for-loops./p>pre>code>{% for tracking in shipment.tracking_links %} <a href{{tracking.url}} classbutton>Track #{{tracking.number}}</a>{% endfor %}/code>/pre>/div>/div>div classcard bg-light mt-3>div classcard-header>strong>Filters/strong>/div>div classcard-body>p>Filters allow you to pipe information, manipulate the input and return any desired output. In the following example, we pipe DK through the country-filter and the resulting output is then piped through the downcase-filter, which will return denmark./p>pre>code>{{ DK | country | downcase }}/code>/pre>p>Currently supported filters:/p>table classtable>thead classthead-light>tr>th>Filter/th>th>Description/th>/tr>/thead>tbody>tr>td>country/td>td>Converts ISO 3166-1 alpha-2 to the name of the country/td>/tr>tr>td>append/td>td>Lets you append something to a string. Example: {{ Webshipper | append: .com }}/td>/tr>tr>td>capitalize/td>td>Will capitalize the first word in a string/td>/tr>tr>td>downcase/td>td>Will downcase a word/td>/tr>tr>td>upcase/td>td>Will upcase a word/td>/tr>tr>td>escape/td>td>Will escape any html content/td>/tr>tr>td>md5/td>td>Converts string into a md5 hash/td>/tr>tr>td>hmac_sha256/td>td>Converts string into SHA-256 hash using HMAC. Example: {{ stringtohash | hmac_sha256: secret }}/td>/tr>tr>td>pluralize/td>td>Outputs singular or plural version. Example: {{ 5 | pluralize: package, packages }} outputs 5 packages/td>/tr>tr>td>prepend/td>td>Prepends to a string. Example: {{ car | prepend: Just bought a }} becomes Just bought a car/td>/tr>tr>td>remove/td>td>Removes all occurrences og a sub-string. Example: {{ Just bought something weird | remove: weird }} becomes Just bought something/td>/tr>tr>td>replace/td>td>Replace a string: {{ Just bought something weird | replace: weird, nice }} becomes Just bought something nice/td>/tr>tr>td>split/td>td>Split a string into substrings. Example: {% assign words  I like webshipper | split:   %}. Will split the sentence into 3 words which can be iterated./td>/tr>tr>td>url_escape/td>td>Escape a URL/td>/tr>tr>td>join/td>td>Joins collection. Example {{ shipment.add_ons | join: ,  }}/td>/tr>tr>td>pdf_attachment/td>td>Include a label or document as a downloadable link. Example {{ label | pdf_attachment(Download Label, return-label.pdf) }}/td>/tr>tr>td>mail_attachment/td>td>Include a label or document as an attachment to an email. Example {{ invoice | mail_attachment(invoice.pdf) }}/td>/tr>tr>td>map/td>td>Pick a element from a array. Example {{ order.order_lines | map: sku }}/td>/tr>tr>td>sum/td>td>Gets the sum from an array of numbers. Example {{ 20,50,100 | sum }}/td>/tr>tr>td>product_sum/td>td>Multiplies the two fields for element in the array and computes the total sum. Example {{ order.order_lines | product_sum: quantity, unit_price }}/td>/tr>tr>td>group_by/td>td>Group an array of object by some path. The key can be a single attribute or a deep dot-separated path. Item will we grouped under N/A if no path or attribute is found. Example {{ shipments | group_by: order.order_channel.order_channel_type }} could yield the object code>{Shopify: {...}, {...}, WooCommerce: {...}}/code>;/td>/tr>tr>td>in_time_zone/td>td>Sets the time zone for formatting a timestamp. Example {{ order.created_at | in_time_zone: Copenhagen | date: %d-%m-%Y %H:%M }} gives 19-10-2018 09:51. Valid values can be found in the TZ column here: a hrefhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones>https://en.wikipedia.org/wiki/List_of_tz_database_time_zones/a>/td>/tr>tr>td>barcode/td>td>Adds the possibility to add barcodes to A4 slip templates and in report columns.br>Takes 2 arguments - first argument is xdim ( width ) second argument is height. Usage: {{234234|barcode: 2,20}}. Will only take effect when this is the only column content.br>br>When used in report column, recommended minimum width of column for a xdim of 2 is 35% and xdim of 1 is 20%/td>/tr>tr>td>round_nearest/td>td>Round integer to nearest defined integer defined in the argument. Can take up to 2 arguments. Example {{ 22.34 | round_rearest: 9 }} will equal 19 or {{ 22.34 | round_rearest: 9, up }}, which will equal 29/td>/tr>tr>td>total_weight_in/td>td>Returns the total weight of all products/items in given array, which has a weight attribute. Example {{ order.order_lines | total_weight_in: kg }}/td>/tr>tr>td>flatten/td>td>Flattens the given array. Can be used to chain the map filter on multiple array properties. Example {{ shipment | map: packages | flatten | map: customs_lines | flatten | map: unit_price | sum }}/td>/tr>/tbody>/table>/div>/div>/div>/div>/div>/div>/div>div classcol-md-6 col-lg-8>/div>/div>div classrow>div classcol-md-6 bg-white> /div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idbrands stylemin-height: 700px;>h2>/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/brands/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>documents/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/brands/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/brands/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/brands/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/brands/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/brands/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idbrands-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreturn_refund_methods stylemin-height: 700px;>h2>/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/return_refund_methods/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>allowed_days/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>payment_required/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>excluded_skus/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>portal/strong>div classtext-muted>has_one/div>br>a href#return_portals>return_portals/a>.strong>return_line/strong>div classtext-muted>has_one/div>br>a href#return_lines>return_lines/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_refund_methods/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_refund_methods/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/return_refund_methods/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/return_refund_methods/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/return_refund_methods/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreturn_refund_methods-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idactions stylemin-height: 700px;>h2>Action/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/actions/div>div classmb-3>/div>p>Actions as part of automations/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>job_type/strong>span classtext-muted pl-2>string/span>/div>p>Name of a supported job: ul> li> CreateShipmentJob /li> /ul>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>async/strong>span classtext-muted pl-2>boolean/span>/div>p>If true, this action runs as a background process, if not it runs immediately/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>additional_attributes/strong>span classtext-muted pl-2>array/span>/div>p>Array of objects containing keys code>attr_values/code> and code>attr_value/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>priority/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>automation/strong>div classtext-muted>has_one/div>br>a href#automations>automations/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/actions/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/actions/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/actions/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/actions/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/actions/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idactions-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idactivities stylemin-height: 700px;>h2>Activity/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/activities/div>div classmb-3>/div>p>Resource for activity./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>details/strong>span classtext-muted pl-2>text/span>/div>p>Details of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latitude/strong>span classtext-muted pl-2>float/span>/div>p>Latitude of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>longitude/strong>span classtext-muted pl-2>float/span>/div>p>Longitude of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>signature/strong>span classtext-muted pl-2>/span>/div>p>Base64 encoded signature of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>signature_name/strong>span classtext-muted pl-2>string/span>/div>p>Name of the signature/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>photo/strong>span classtext-muted pl-2>/span>/div>p>Base64 encoded photo of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>initiator/strong>span classtext-muted pl-2>string/span>/div>p>Initiator of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>activity_type/strong>div classtext-muted>has_one/div>br>a href#activity_types>activity_types/a>.strong>status_event_type/strong>div classtext-muted>has_one/div>br>a href#activity_types>activity_types/a>.strong>model/strong>div classtext-muted>has_one/div>br>Polymorphic.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/activities/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/activities/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/activities/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/activities/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/activities/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idactivities-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idactivity_types stylemin-height: 700px;>h2>Activity Types/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/activity_types/div>div classmb-3>/div>p>Read only resource for activity types./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>activity_description/strong>span classtext-muted pl-2>string/span>/div>p>Description of the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>activity_key/strong>span classtext-muted pl-2>string/span>/div>p>Key for the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>model/strong>span classtext-muted pl-2>string/span>/div>p>Model for the activity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>model_status/strong>span classtext-muted pl-2>string/span>/div>p>Status of the model/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>requires_signature/strong>span classtext-muted pl-2>boolean/span>/div>p>Does the activity require a signature/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>requires_photo/strong>span classtext-muted pl-2>boolean/span>/div>p>Does the activity require a photo/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>active/strong>span classtext-muted pl-2>boolean/span>/div>p>Is the activity active/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>priority/strong>span classtext-muted pl-2>integer/span>/div>p>Priority of the activity/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>active/code>, code>model/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/activity_types/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/activity_types/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/activity_types/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/activity_types/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/activity_types/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idactivity_types-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idadditional_attributes stylemin-height: 700px;>h2>Additional Attribute/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/additional_attributes/div>div classmb-3>/div>p>This resource is used to attach info to orders and order lines/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>Visible name of the attribute/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>attr_key/strong>span classtext-muted pl-2>string/span>/div>p>Key for the attribute/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>attr_value/strong>span classtext-muted pl-2>text/span>/div>p>Value of the attribute/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>order/strong>div classtext-muted>has_one/div>br>a href#orders>orders/a>.strong>order_line/strong>div classtext-muted>has_one/div>br>a href#order_lines>order_lines/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/additional_attributes/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/additional_attributes/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/additional_attributes/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/additional_attributes/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/additional_attributes/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idadditional_attributes-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idattachments stylemin-height: 700px;>h2>Attachment/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/attachments/div>div classmb-3>/div>p>Attachment are used to associate existing Documents with Orders and Shipments./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>document/strong>div classtext-muted>has_one/div>br>a href#documents>documents/a>.strong>has_documents/strong>div classtext-muted>has_one/div>br>Polymorphic.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/attachments/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/attachments/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/attachments/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/attachments/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/attachments/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idattachments-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#attachments_Use cases_samples idpills-attachments-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idattachments_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/attachments/div>p classtext-muted>Attaching to an Order/p>pre>code classjson>{
  data: {
    type: attachments,
    relationships: {
      document: {
        data: {
          type: documents,
          id: 532
        }
      },
      has_documents: {
        data: {
          type: orders,
          id: 532
        }
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/attachments/div>p classtext-muted>Attaching to a Shipment/p>pre>code classjson>{
  data: {
    type: shipments,
    attributes: {
      included_documents: 
        {
          document_id: 1
        }
      
    },
    relationships: {
      order: {
        data: {
          type: orders,
          id: 123
        }
      }
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idautomations stylemin-height: 700px;>h2>Automation/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/automations/div>div classmb-3>/div>p>With Automations you can build custom workflows on the Webshipper platform using highly flexible Triggers and Actions./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>trigger/strong>span classtext-muted pl-2>object/span>/div>p>Flattened resource of type Trigger/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>actions/strong>span classtext-muted pl-2>array/span>/div>p>Array of flattened resources of type Action /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>enabled/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>priority/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>automation_type/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>activity_type/strong>div classtext-muted>has_one/div>br>a href#activity_types>activity_types/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/automations/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/automations/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/automations/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/automations/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/automations/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idautomations-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idautomations_dry_runs stylemin-height: 700px;>h2>Automations Dry Run/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/automations_dry_runs/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>dry_run/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>automation/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>report_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>model_type/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>element_name/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/automations_dry_runs/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/automations_dry_runs/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/automations_dry_runs/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/automations_dry_runs/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/automations_dry_runs/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idautomations_dry_runs-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idbarcode_ranges stylemin-height: 700px;>h2>Barcode Range/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/barcode_ranges/div>div classmb-3>/div>p>This resource is used to describe the barcode ranges provided to you by a carrier./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>barcode_type/strong>span classtext-muted pl-2>string/span>/div>p>String like DPD or SSCC/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>serial_from/strong>span classtext-muted pl-2>integer/span>/div>p>The first barcode in the range/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>serial_to/strong>span classtext-muted pl-2>integer/span>/div>p>The last barcode in the range/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>current_serial/strong>span classtext-muted pl-2>integer/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The last used (highest) barcode serial/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>usage_status/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>replaces_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/barcode_ranges/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/barcode_ranges/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/barcode_ranges/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/barcode_ranges/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/barcode_ranges/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idbarcode_ranges-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idbulk_import_orders stylemin-height: 700px;>h2>Bulk import orders/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/bulk_import_orders/div>div classmb-3>/div>p>Bulk import orders based on an array of ids/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>ids/strong>span classtext-muted pl-2>/span>/div>p>Order ids to import from the order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>/span>/div>p>Id of the order channel to import orders from/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>async/strong>span classtext-muted pl-2>/span>/div>p>Run the import asyncronously, default is false unless importing more than one order or from more than one order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>reimport/strong>span classtext-muted pl-2>/span>/div>p>Reimport orders from the order channel. WARNING: This will overwrite any changes to the order made in Webshipper and import the order as it is in the order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>time_start/strong>span classtext-muted pl-2>/span>/div>p>Time from when orders should be imported, all orders after this time is imported from the order channel. This option is not supported by all order channels and there might be some limitations depending on the order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>time_end/strong>span classtext-muted pl-2>/span>/div>p>Time to when orders should be imported, all orders before this time is imported from the order channel. This option is not supported by all order channels and there might be some limitations depending on the order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>statuses/strong>span classtext-muted pl-2>/span>/div>p>Statuses of orders to import, all orders with the given statuses are imported from the order channel. This option is not supported by all order channels and there might be some limitations depending on the order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>bulk_imports/strong>span classtext-muted pl-2>/span>/div>p>List of bulk imports with the same attributes as above. This can be used to import multiple orders from multiple order channels at once. Options specified in the root object is used globally, but is overridable by specififying the option for specific bulk_import in the list./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>source/strong>span classtext-muted pl-2>/span>/div>p>Source of the orders to import. This will default to API/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/bulk_import_orders/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/bulk_import_orders/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/bulk_import_orders/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/bulk_import_orders/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/bulk_import_orders/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idbulk_import_orders-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcsv_mappings stylemin-height: 700px;>h2>CSV Mapping/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/csv_mappings/div>div classmb-3>/div>p>Describes how to parse an uploaded CSV file/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>separator/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The seperator in the file. Normally ; or ,/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>target_class/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Must be one of the models code>Order/code> or code>Shipment/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>grouped_by/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>Must be the index of the Order ID/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>grouped_path/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The sub-model which you are grouping. For order: order_lines_attributes/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>includes_header/strong>span classtext-muted pl-2>boolean/span>/div>p>Determines if there is an ignorable header line in the file/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>lines_as_package/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>recreate_order_lines/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>separate_order_line_mapping/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Name of the configuration/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>example_input/strong>span classtext-muted pl-2>text/span>/div>p>Example input to make it easier to create the mapping in the UI./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>line_example_input/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>rules/strong>span classtext-muted pl-2>array/span>/div>p>Array of flattened resources of the type CSV Rule/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_export_format/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_export_format/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>create_shipment_automatically/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>force_async/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>concat_paths/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>split_large_records/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>export_file_extension/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>order_channel/strong>div classtext-muted>has_one/div>br>a href#order_channels>order_channels/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/csv_mappings/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/csv_mappings/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/csv_mappings/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/csv_mappings/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/csv_mappings/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcsv_mappings-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcsv_rules stylemin-height: 700px;>h2>CSV Mapping Rule/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/csv_rules/div>div classmb-3>/div>p>Describes how an entry in a CSV file should map to an attribute in a resource./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>target_path/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Path of the attribute to update/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>source_index/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>The index of the field in the CSV file to be mapped/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>default_value/strong>span classtext-muted pl-2>string/span>/div>p>Value to use if the value in the CSV file is empty or missing/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>input_conversions/strong>span classtext-muted pl-2>object/span>/div>p>A key/value mapping for converting values before creating the object/p>hr>/div>h5>Relationships/h5>strong>mapping/strong>div classtext-muted>has_one/div>br>a href#csv_mappings>csv_mappings/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/csv_rules/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/csv_rules/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/csv_rules/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/csv_rules/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/csv_rules/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcsv_rules-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcsv_uploads stylemin-height: 700px;>h2>CSV Upload/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/csv_uploads/div>div classmb-3>/div>p>Used to import records from CSV files (or similar formats). CSV Mapping Rules provides the details for how to import the records./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>imported/strong>span classtext-muted pl-2>array/span>/div>p>div classbadge badge-warning mr-3>Read only/div>A list of ids of the imported records/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>input/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The raw CSV data/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>input_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>import_errors/strong>span classtext-muted pl-2>array/span>/div>p>div classbadge badge-warning mr-3>Read only/div>A list of error messages for items that could not be imported/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>async/strong>span classtext-muted pl-2>boolean/span>/div>p>If set to true, the import will be performed in background. Highly recommended for imports larger than 100 rows./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>make_exportable/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>mapping/strong>div classtext-muted>has_one/div>br>a href#csv_mappings>csv_mappings/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/csv_uploads/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcsv_uploads-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcarriers stylemin-height: 700px;>h2>Carrier/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/carriers/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>alias/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Your name for the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>services/strong>span classtext-muted pl-2>/span>/div>p>Array of services provided by this Carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>attrs/strong>span classtext-muted pl-2>/span>/div>p>Array of hashes with keys: code>attr_key/code>, code>attr_value/code>, code>attr_name/code>, code>attr_type/code>, code>is_required/code>, code>only_visible_on_creation/code>, /code>enums/code>. See      documentation for Local Attributes/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>prefer_zpl/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_approved/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>approved_service_codes/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_parameter_enums/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>barcode_notification_behavior/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>barcode_notification_mail/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>has_active_cost_sheet/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>delete_at_carrier/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>test_mode/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>logo/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>logo_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>print_error_label/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ftp_configuration_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>carrier_type/strong>div classtext-muted>has_one/div>br>a href#carrier_types>carrier_types/a>.strong>sender_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>return_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>shipping_rates/strong>div classtext-muted>has_many/div>br>a href#shipping_rates>shipping_rates/a>.strong>cost_sheets/strong>div classtext-muted>has_many/div>br>a href#cost_sheets>cost_sheets/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>billable/code>, code>carrier_type_codes/code>, code>carrier_group_id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/carriers/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/carriers/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/carriers/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/carriers/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/carriers/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcarriers-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcarrier_accesses stylemin-height: 700px;>h2>Carrier Access/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/carrier_accesses/div>div classmb-3>/div>p>Grants access to the carriers shipments for a single user. This has no effect if the user has access to all carriers./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>user/strong>div classtext-muted>has_one/div>br>a href#users>users/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/carrier_accesses/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/carrier_accesses/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/carrier_accesses/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/carrier_accesses/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcarrier_accesses-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcarrier_types stylemin-height: 700px;>h2>Carrier Type/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/carrier_types/div>div classmb-3>/div>p>Read-only endpoint to fetch information of the available carrier types./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>fulfillment_logo/strong>span classtext-muted pl-2>/span>/div>p>Logo for the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>list_logo/strong>span classtext-muted pl-2>/span>/div>p>Logo for the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>Name of the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_code/strong>span classtext-muted pl-2>string/span>/div>p>Code identifying the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>Description of the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>required_details/strong>span classtext-muted pl-2>text/span>/div>p>Details required to use the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>requires_dutiable/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_zpl/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_pickup/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_tracking/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_price_quoting/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>requires_approval/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_documents/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_shipment_updates/strong>span classtext-muted pl-2>boolean/span>/div>p>Boolean indicating wether the carrier supports shipment updates/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_updates_limit_minutes/strong>span classtext-muted pl-2>integer/span>/div>p>Number of minutes before shipment time a shipment can be updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>barcode_mail/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_price_pdf_upload/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_deletion/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>barcode_customer_notification_mail_template_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>colli_type_support/strong>span classtext-muted pl-2>integer/span>/div>p>Determines whether the carrier supports colli types.Values should be one of the following. null: Not supported, carrier_provided: Values are determined by the carrier, webshipper_provided: Default Webshipper colli types, customer_provided: The customer can input colli types specific to their aggreement with the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>beta/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_test_mode/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>show_send_time/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_shadow_bookings/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>rate_quote_validation/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_group_id/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>require_ftp_configuration_id/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>hide/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>onboarding_url/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_edi/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>local_attrs/strong>div classtext-muted>has_many/div>br>a href#local_attrs>local_attrs/a>.strong>carriers/strong>div classtext-muted>has_many/div>br>a href#carriers>carriers/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>carrier_code/code>, code>carrier_group_id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/carrier_types/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/carrier_types/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcarrier_types-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcomments stylemin-height: 700px;>h2>Comment/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/comments/div>div classmb-3>/div>p>Comments are used to add information to a model. The model can be a shipment, order or return ./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>comment/strong>span classtext-muted pl-2>text/span>/div>p>The comment text./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>initiator/strong>span classtext-muted pl-2>string/span>/div>p>The user that created the comment./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>comment_type/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The type of comment. Possible values: internal_comment or external_comment/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>model/strong>div classtext-muted>has_one/div>br>Polymorphic.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/comments/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/comments/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/comments/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/comments/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/comments/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcomments-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#comments_Full CREATE Sample_samples idpills-comments-Full CREATE Sample-tab roletab>Full CREATE Sample/a>/li>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link  data-togglepill href#comments_Use cases_samples idpills-comments-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idcomments_Full CREATE Sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/comments/div>p classtext-muted>/p>/div>div aria-labelledbypills-home-tab classtab-pane fade show  idcomments_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/comments/div>p classtext-muted>Create a comment/p>pre>code classjson>{
  data: {
    type: comments,
    attributes: {
      comment: This is a comment,
      initiator: John Doe,
      comment_type: internal_comment
    }
  },
  relationships: {
    order: {
      data: {
        id: 123456,
        type: orders
      }
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idcustoms_lines stylemin-height: 700px;>h2>Customs Line/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/customs_lines/div>div classmb-3>/div>p>Customs Lines is generally created as part of a shipment creation and should it should never be necessary to call this resource directly./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>sku/strong>span classtext-muted pl-2>string/span>/div>p>Stock Keeping Unit/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>Goods description/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>quantity/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>Quantity of the customs line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tarif_number/strong>span classtext-muted pl-2>string/span>/div>p>Tariff number / HS code/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>country_of_origin/strong>span classtext-muted pl-2>string/span>/div>p>Country of origin of the customs line - ISO 3166-1 alpha-2/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>unit_price/strong>span classtext-muted pl-2>float/span>/div>p>Unit price of a single quantity customs line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>vat_percent/strong>span classtext-muted pl-2>float/span>/div>p>Vat percent of the customs line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>currency/strong>span classtext-muted pl-2>string/span>/div>p>Currency ISO-4217/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight/strong>span classtext-muted pl-2>float/span>/div>p>Weight of a single quantity customs line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight_unit/strong>span classtext-muted pl-2>integer/span>/div>p>Weight unit of the customs line - One of g, oz, lbs or kg/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>discount/strong>span classtext-muted pl-2>float/span>/div>p>Discount of a single quantity customs line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dangerous_goods_details/strong>span classtext-muted pl-2>object/span>/div>p>Optional object of key value pairs used for providing information of dangerous goods. For use with DGOffice, use keys: article_no, package_type_id and packaging_instruction_type./p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/customs_lines/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/customs_lines/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/customs_lines/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/customs_lines/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/customs_lines/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idcustoms_lines-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column iddocuments stylemin-height: 700px;>h2>Document/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/documents/div>div classmb-3>/div>p>Additional shipment documents. This is used for customs declarations etc. Documents are limited to 5mb./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>shipment_id/strong>span classtext-muted pl-2>integer/span>/div>p>Id of the shipment it belongs to/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>document_size/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Enum for the paper size. valid values: code>A4/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>document_format/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Enum for the document format. Valid values: code>PDF/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>required/span>/div>p>Base64 representation of the document. Only required when creating./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_special/strong>span classtext-muted pl-2>boolean/span>/div>p>Used to indicate if this document is a special document, like static customs documents. Special documents will be displayed in Webshipper under Settings > Documents./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>Used for special documents/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>Used for special documents/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>document_type/strong>span classtext-muted pl-2>integer/span>/div>p>One of: shipping_document, other, customs_document, invoice, certificate, proforma, nafta_certificate, commercial, awb. Documents returned from the carrier are always shipping_document. /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_paperless/strong>span classtext-muted pl-2>boolean/span>/div>p>Used to indicate if a shipment is paperless/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>has_documents/strong>div classtext-muted>has_one/div>br>Polymorphic.strong>print_jobs/strong>div classtext-muted>has_many/div>br>a href#printer_jobs>printer_jobs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>is_special/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/documents/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/documents/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/documents/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/documents/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/documents/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 iddocuments-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column iddocument_templates stylemin-height: 700px;>h2>Document Templates/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/document_templates/div>div classmb-3>/div>p>Read only resource for document templates./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>copies/strong>span classtext-muted pl-2>integer/span>/div>p>Number of copies/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>document_type/strong>span classtext-muted pl-2>integer/span>/div>p>Type of document/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>overrides/strong>span classtext-muted pl-2>text/span>/div>p>Overrides for the document/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>defaults/strong>span classtext-muted pl-2>/span>/div>p>Defaults for the document/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>notify/strong>span classtext-muted pl-2>boolean/span>/div>p>Notify/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email_address/strong>span classtext-muted pl-2>string/span>/div>p>Email address/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email_body/strong>span classtext-muted pl-2>text/span>/div>p>Email body/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email_filename/strong>span classtext-muted pl-2>string/span>/div>p>Email filename/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>document_type/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/document_templates/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/document_templates/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/document_templates/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/document_templates/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/document_templates/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 iddocument_templates-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column iddrop_points stylemin-height: 700px;>h2>Drop Point/h2>div classd-flex flex-column>div classmb-3>/div>p>Drop point for orders. To locate drop points, please refer to Drop Point Locator/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>drop_point_id/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The carriers ID of the drop point./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Name of the drop point/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_1/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Address line 1 of the drop point/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_2/strong>span classtext-muted pl-2>string/span>/div>p>Address line 2 of the drop point/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>zip/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Zip code for the drop point/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>city/strong>span classtext-muted pl-2>requiredstring/span>/div>p>City for the drop point/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>country_code/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Country Code for the drop point. ISO 3166-1 Alfa 2 /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>state/strong>span classtext-muted pl-2>string/span>/div>p>State code. ISO 3166-2 Alfa 2/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>phone/strong>span classtext-muted pl-2>string/span>/div>p>Phone of the drop point/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_code/strong>span classtext-muted pl-2>string/span>/div>p>Text base code to identify the carrier of the drop point ( not mandatory )/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>routing_code/strong>span classtext-muted pl-2>string/span>/div>p>Routing code for the drop point./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>longitude/strong>span classtext-muted pl-2>string/span>/div>p>Longitude/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latitude/strong>span classtext-muted pl-2>string/span>/div>p>Latitude/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>opening_hours/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Opening hours for the drop point. Days are 0-indexed, starting with Monday as 0/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>em classtext-muted>No routes available for this resource. It can only be accesses as a flattened resource in other resources/em>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 iddrop_points-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column iddrop_point_locators stylemin-height: 700px;>h2>Drop Point Locator/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/drop_point_locators/div>div classmb-3>/div>p>Used to find the geographically closest drop points./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>carrier_id/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>ID of the carrier that you want to quote. strong>This is only mandatory if no shipping_rate_id is given/strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_code/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Service code for the service that you want to quote. strong>This is only mandatory if no shipping_rate_id is given./strong>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_rate_id/strong>span classtext-muted pl-2>required/span>/div>p>ID of the shipping rate that you want to quote. strong>This is only mandatory if no carrier_id is given./strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>drop_point_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>delivery_address/strong>span classtext-muted pl-2>required/span>/div>p>Flattened shipping address object. code>zip/code> and code>country_code/code>  are required and code>address_1/code> is optional./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>drop_points/strong>span classtext-muted pl-2>array/span>/div>p>Array of drop points near delivery_address. This will be populated in the response./p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/drop_point_locators/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 iddrop_point_locators-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#drop_point_locators_Use cases_samples idpills-drop_point_locators-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active iddrop_point_locators_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/drop_point_locators/div>p classtext-muted>Query droppoints near address by carrier and service code/p>pre>code classjson>{
  data: {
    type: drop_point_locators,
    attributes: {
      carrier_id: 1,
      service_code: PARCELSHOP,
      delivery_address: {
        address_1: Lyngbygade 8,
        zip: 8600,
        city: Silkeborg,
        country_code: DK
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/drop_point_locators/div>p classtext-muted>Query droppoints near address by shipping rate ID/p>pre>code classjson>{
  data: {
    type: drop_point_locators,
    attributes: {
      shipping_rate_id: 1,
      delivery_address: {
        address_1: Lyngbygade 8,
        zip: 8600,
        city: Silkeborg,
        country_code: DK
      }
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idedis stylemin-height: 700px;>h2>EDI/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/edis/div>div classmb-3>/div>p>This resource describes an EDI file. This file will be uploaded to an FTP server configured by the carrier./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>integer/span>/div>p>Must be one of pending, on_hold or sent/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>data/strong>span classtext-muted pl-2>text/span>/div>p>The file contents (as text)/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>encoding/strong>span classtext-muted pl-2>integer/span>/div>p>Must be either utf8 or ascii/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_code/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Text-based code representing the carrier type./p>hr>/div>h5>Relationships/h5>strong>shipment/strong>div classtext-muted>has_one/div>br>a href#shipments>shipments/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>shipment_id/code>, code>waybill_id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/edis/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/edis/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idedis-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idend_of_day_reports stylemin-height: 700px;>h2>End-of-day report/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/end_of_day_reports/div>div classmb-3>/div>p>A report of all shipment for the day of start_time./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>/span>/div>p>Base64 encoding of the PDF document. This must explicitly be included with fieldsend_of_day_reportsbase64/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>start_time/strong>span classtext-muted pl-2>datetime/span>/div>p>Datetime representing the start time for the report/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>end_time/strong>span classtext-muted pl-2>datetime/span>/div>p>Datetime representing the end time for the report/p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>print_jobs/strong>div classtext-muted>has_many/div>br>a href#printer_jobs>printer_jobs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/end_of_day_reports/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/end_of_day_reports/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/end_of_day_reports/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/end_of_day_reports/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/end_of_day_reports/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idend_of_day_reports-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column iderror_types stylemin-height: 700px;>h2>Error Type/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/error_types/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>translations/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>matcher/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>error_class/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>support_url/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/error_types/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/error_types/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/error_types/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/error_types/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/error_types/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 iderror_types-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idevents stylemin-height: 700px;>h2>Event/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/events/div>div classmb-3>/div>p>Timeline event for orders or shipments/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>title/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>details/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>icon/strong>span classtext-muted pl-2>string/span>/div>p>FontAwesome 4 compatible icon like: exclamation, trash, truck, envelope, cog, anchor, map-marker, certificate/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>initiator/strong>span classtext-muted pl-2>string/span>/div>p>Will be set by the Webshipper API/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>source/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>model/strong>div classtext-muted>has_one/div>br>Polymorphic.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/events/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/events/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/events/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/events/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/events/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idevents-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#events_Use cases_samples idpills-events-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idevents_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/events/div>p classtext-muted>Adding event to order/p>pre>code classjson>{
  data: {
    type: events,
    attributes: {
      title: Unable to capture order,
      details: Log reference 12333-34-23-342,
      icon: exclamation
    },
    relationships: {
      model: {
        data: {
          type: orders,
          id: 100
        }
      }
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idevent_models stylemin-height: 700px;>h2>EventModel/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/event_models/div>div classmb-3>/div>p>/p>h5>Attributes/h5>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/event_models/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/event_models/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/event_models/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/event_models/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/event_models/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idevent_models-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idfavourite_pages stylemin-height: 700px;>h2>Favourite Page/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/favourite_pages/div>div classmb-3>/div>p>Favourite page lets you store a list of favourite pages to easily navigate the Webshipper platform. The favourites can quickly be accessed by assigning it a hotkey/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>path/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Path of the favourite page/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>text/span>/div>p>Name of the favourite page/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>user_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>user/strong>div classtext-muted>has_one/div>br>a href#users>users/a>.strong>hot_key/strong>div classtext-muted>has_one/div>br>a href#hot_keys>hot_keys/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>user_id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/favourite_pages/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/favourite_pages/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/favourite_pages/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/favourite_pages/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/favourite_pages/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idfavourite_pages-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idhas_documents stylemin-height: 700px;>h2>Has Documents/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/has_documents/div>div classmb-3>/div>p>/p>h5>Attributes/h5>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/has_documents/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/has_documents/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/has_documents/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/has_documents/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/has_documents/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idhas_documents-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idhot_keys stylemin-height: 700px;>h2>HotKey/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/hot_keys/div>div classmb-3>/div>p>Hot key lets you define a key combination for quickly accessing your favourite pages/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>hot_key/strong>span classtext-muted pl-2>string/span>/div>p>Key combination of the hotkey/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>path/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Path the hotkey is assigned to/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>favourite_page_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>user_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>favourite_page/strong>div classtext-muted>has_one/div>br>a href#favourite_pages>favourite_pages/a>.strong>user/strong>div classtext-muted>has_one/div>br>a href#users>users/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/hot_keys/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/hot_keys/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/hot_keys/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/hot_keys/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/hot_keys/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idhot_keys-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idlabels stylemin-height: 700px;>h2>Label/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/labels/div>div classmb-3>/div>p>A shipping label. Shipping labels wrap PDF documents.br>Accepts a query parameter called download_as which can be either PDF or PNG.br>b>Note/b>: when download_as is set to something other than PDF, the returned value in the base64 attribute will be an array of base64 strings, instead of a single base64 string/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>shipment_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>label_size/strong>span classtext-muted pl-2>integer/span>/div>p>Size of the label. Enum with possible values: 100X100, 100X150, 100X192, A4./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>label_format/strong>span classtext-muted pl-2>integer/span>/div>p>Label format. Enum with possible values: PDF, ZPL./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>/span>/div>p>Base64 encoding of the pdf document. (Can be an array, see the description above)/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>print_jobs/strong>div classtext-muted>has_many/div>br>a href#printer_jobs>printer_jobs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/labels/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/labels/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idlabels-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#labels_Full sample_samples idpills-labels-Full sample-tab roletab>Full sample/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idlabels_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/labels/1/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 1,    type: labels,    links: {      self: /v2/labels/1    },    attributes: {      shipment_id: 2,      label_size: 100X150,      label_format: PDF,      base64: null,      updated_at: 2025-09-10T04:27:38.0Z,      created_at: 2025-09-10T04:27:38.0Z    },    relationships: {      print_jobs: {        links: {          self: /v2/labels/1/relationships/print_jobs,          related: /v2/labels/1/print_jobs        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idlocal_attrs stylemin-height: 700px;>h2>Local Attribute/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/local_attrs/div>div classmb-3>/div>p>As opposed to Global Attributes, Local Attributes are used for creating Attributes for Order Channels and Carriers./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>attr_name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Visible name of the attribute/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>attr_key/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Key for the attribute. Used by the system to read the correct information/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>attr_type/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Data type. Must be either of the following: code>string/code>, code>integer/code> or code>password/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_required/strong>span classtext-muted pl-2>boolean/span>/div>p>Determines if the form should require the attr to be filled/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>string/span>/div>p>Help text to describe the attribute/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>requirement_type/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>category/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>priority/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>only_visible_on_creation/strong>span classtext-muted pl-2>boolean/span>/div>p>Determines if the form should only be visible when connecting/p>hr>/div>h5>Relationships/h5>strong>order_channel_type/strong>div classtext-muted>has_one/div>br>a href#order_channel_types>order_channel_types/a>.strong>local_attr_enums/strong>div classtext-muted>has_many/div>br>a href#local_attr_enums>local_attr_enums/a>.strong>local_attr_translations/strong>div classtext-muted>has_many/div>br>a href#local_attr_translations>local_attr_translations/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/local_attrs/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/local_attrs/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idlocal_attrs-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#local_attrs_Full sample_samples idpills-local_attrs-Full sample-tab roletab>Full sample/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idlocal_attrs_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/local_attrs/9/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 9,    type: local_attrs,    links: {      self: /v2/local_attrs/9    },    attributes: {      attr_name: Shop Access Token,      attr_key: access_token,      attr_type: password,      is_required: true,      description: null,      requirement_type: carrier_details,      category: null,      priority: null,      only_visible_on_creation: false    },    relationships: {      order_channel_type: {        links: {          self: /v2/local_attrs/9/relationships/order_channel_type,          related: /v2/local_attrs/9/order_channel_type        }      },      local_attr_enums: {        links: {          self: /v2/local_attrs/9/relationships/local_attr_enums,          related: /v2/local_attrs/9/local_attr_enums        }      },      local_attr_translations: {        links: {          self: /v2/local_attrs/9/relationships/local_attr_translations,          related: /v2/local_attrs/9/local_attr_translations        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idlocal_attr_enums stylemin-height: 700px;>h2>Local Attribute Enums/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/local_attr_enums/div>div classmb-3>/div>p>A set of predefined values allowed for a Local Attribute./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>enum_name/strong>span classtext-muted pl-2>string/span>/div>p>Visible name for the enum/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>enum_value/strong>span classtext-muted pl-2>string/span>/div>p>Value for the enum/p>hr>/div>h5>Relationships/h5>strong>local_attr/strong>div classtext-muted>has_one/div>br>a href#local_attrs>local_attrs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/local_attr_enums/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/local_attr_enums/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idlocal_attr_enums-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#local_attr_enums_Full sample_samples idpills-local_attr_enums-Full sample-tab roletab>Full sample/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idlocal_attr_enums_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/local_attr_enums/9/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 9,    type: local_attr_enums,    links: {      self: /v2/local_attr_enums/9    },    attributes: {      enum_name: null,      enum_value: null    },    relationships: {      local_attr: {        links: {          self: /v2/local_attr_enums/9/relationships/local_attr,          related: /v2/local_attr_enums/9/local_attr        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idmail_template_previews stylemin-height: 700px;>h2>Mail Template Preview/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/mail_template_previews/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>mail/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>mail_template/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>mail_locale/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>locale/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>return_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>brand_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>hook/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>overrides/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>lang/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>defaults/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>to/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>whitelisted_languages/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/mail_template_previews/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/mail_template_previews/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/mail_template_previews/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/mail_template_previews/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/mail_template_previews/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idmail_template_previews-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idmail_templates stylemin-height: 700px;>h2>Mail Templates/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/mail_templates/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>default_locale/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>mail_locales/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>images/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>purpose/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>bcc_mail/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_prebuilt/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>overrides/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>defaults/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>hook/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>whitelisted_languages/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>used_by_shipping_rates/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>described/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Encapsulated with new WYSIWYG editor and legacy HTML based templates/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>used_by_order_channels/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>which order_channels use mail_template. If not used by any, it will return empty list/p>hr>/div>h5>Relationships/h5>strong>brand/strong>div classtext-muted>has_one/div>br>a href#brands>brands/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>purpose/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/mail_templates/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/mail_templates/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/mail_templates/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/mail_templates/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/mail_templates/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idmail_templates-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idorder_merges stylemin-height: 700px;>h2>Merged Order/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/order_merges/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>order_id/strong>span classtext-muted pl-2>requiredboolean/span>/div>p>ID of order to merge order lines in to/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>orders/strong>span classtext-muted pl-2>requiredarray/span>/div>p>Orders from which to merge order lines from. Orders as nested resources/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/order_merges/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idorder_merges-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idpdf_merges stylemin-height: 700px;>h2>Merged PDF/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/pdf_merges/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>include_labels/strong>span classtext-muted pl-2>requiredboolean/span>/div>p>Whether to include labels or not/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>include_docs/strong>span classtext-muted pl-2>requiredboolean/span>/div>p>Whether to include docs or not /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>include_slips/strong>span classtext-muted pl-2>requiredboolean/span>/div>p>Whether to include slips or not/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>force_a4/strong>span classtext-muted pl-2>requiredboolean/span>/div>p>Whether to use A4 paper size not/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_ids/strong>span classtext-muted pl-2>array/span>/div>p>A list of shipment ids to include in the merged pdf/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_ids/strong>span classtext-muted pl-2>array/span>/div>p>A list of order ids to include in the merged pdf/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>url/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>failed/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/pdf_merges/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/pdf_merges/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idpdf_merges-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idmodels stylemin-height: 700px;>h2>Model/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/models/div>div classmb-3>/div>p>/p>h5>Attributes/h5>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/models/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/models/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/models/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/models/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/models/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idmodels-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idoauth_access_tokens stylemin-height: 700px;>h2>OAuth Access Token/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/oauth_access_tokens/div>div classmb-3>/div>p>This resource describes all of the access tokens for the appllication./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>scopes/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The scopes to which access is granted by the access token./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>resource_owner_id/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>Id of the owner/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>expires_in/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>Epoch timestamp of the expiration date for the token/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>expired/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>token/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The access token/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>revoked_at/strong>span classtext-muted pl-2>datetime/span>/div>p>Datetime of the time the token was revoked - if revoked/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>resource_owner/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>application_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>application/strong>span classtext-muted pl-2>/span>/div>p>The application to which this tokens grants access/p>hr>/div>h5>Relationships/h5>strong>application/strong>div classtext-muted>has_one/div>br>a href#oauth_applications>oauth_applications/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/oauth_access_tokens/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/oauth_access_tokens/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idoauth_access_tokens-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#oauth_access_tokens_Full sample_samples idpills-oauth_access_tokens-Full sample-tab roletab>Full sample/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idoauth_access_tokens_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/oauth_access_tokens/1/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 1,    type: oauth_access_tokens,    links: {      self: /v2/oauth_access_tokens/1    },    attributes: {      scopes: read_orders,read_shipments,      created_at: null,      resource_owner_id: null,      expires_in: null,      expired: null,      revoked_at: null,      resource_owner: null,      application_id: null    },    relationships: {      application: {        links: {          self: /v2/oauth_access_tokens/1/relationships/application,          related: /v2/oauth_access_tokens/1/application        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idoauth_applications stylemin-height: 700px;>h2>OAuth Application/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/oauth_applications/div>div classmb-3>/div>p>Applications which can act on behalf of users in Webshipper. Application Tokens have infinite lifetime. See the section titled Authentication for more details on using OAuth2./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Application name/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>uid/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Unique id/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>scopes/strong>span classtext-muted pl-2>string/span>/div>p>The scopes which the OAuth application will be granted./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>redirect_uri/strong>span classtext-muted pl-2>text/span>/div>p>OAuth redirect URI/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>h5>Relationships/h5>strong>access_tokens/strong>div classtext-muted>has_many/div>br>a href#oauth_access_tokens>oauth_access_tokens/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>uid/code>, code>active/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/oauth_applications/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/oauth_applications/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idoauth_applications-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#oauth_applications_Full sample_samples idpills-oauth_applications-Full sample-tab roletab>Full sample/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idoauth_applications_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/oauth_applications/1/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 1,    type: oauth_applications,    links: {      self: /v2/oauth_applications/1    },    attributes: {      name: Webshipr Silent Printer,      uid: 61562ee483af1ce331444013ab8c167201615465e9e5f0067b,      scopes: read_orders,read_shipments,      redirect_uri: null,      created_at: null,      updated_at: null    },    relationships: {      access_tokens: {        links: {          self: /v2/oauth_applications/1/relationships/access_tokens,          related: /v2/oauth_applications/1/access_tokens        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idorders stylemin-height: 700px;>h2>Order/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/orders/div>div classmb-3>/div>p>Orders can be used to keep track of items to be shipped, for example when preparing the contents of a parcel and following that, an order can be the basis for one or more shipments. Orders can also handle customs information as well as shipping rates./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>integer/span>/div>p>DEPRECATED Assign a relation instead/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Enum status of the order. Possible values: pending, dispatched, partly_dispatched, cancelled, error, missing_rate, on_hold/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ext_ref/strong>span classtext-muted pl-2>string/span>/div>p>External ( hidden ) reference for the order. Used by system to update the order in e.g. order channels. Must be unique in scope of order channels./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>visible_ref/strong>span classtext-muted pl-2>string/span>/div>p>Visible reference - the friendly/visible external order number/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>drop_point/strong>span classtext-muted pl-2>object/span>/div>p>Flattened resource of type DropPoint. Must be assigned when the order must be delivered to a drop point./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>original_shipping/strong>span classtext-muted pl-2>object/span>/div>p>Flattened resource describing the original shipping option from the order channel. This will be used for matching in cases where shipping was not quoted from Webshipper./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_lines/strong>span classtext-muted pl-2>requiredarray/span>/div>p>Flattened resource of type OrderLine/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>delivery_address/strong>span classtext-muted pl-2>requiredobject/span>/div>p>Flattened resource of type ShippingAddress/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sender_address/strong>span classtext-muted pl-2>object/span>/div>p>Flattened resource of type ShippingAddress. If the address is not assigned - the sender address of the order channel will be used./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>billing_address/strong>span classtext-muted pl-2>object/span>/div>p>Flattened resource of type ShippingAddress. Will be duplicated from delivery address if not assigned./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sold_from_address/strong>span classtext-muted pl-2>object/span>/div>p>Flattened resource of type ShippingAddress. Will be duplicated from sender address if not assigned./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>currency/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Currency code of the order/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>internal_comment/strong>span classtext-muted pl-2>string/span>/div>p>DEPRECATED Please use the Comments model instead/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>external_comment/strong>span classtext-muted pl-2>string/span>/div>p>DEPRECATED Please use the Comments model instead/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>error_message/strong>span classtext-muted pl-2>object/span>/div>p>Any error message that resulted from the latest attempt at making a shipment from the order./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>slip/strong>span classtext-muted pl-2>string/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The order slip in PDF format using base64 encoding. This will only be included if the parameter fieldsorders includes slip./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>lock_state/strong>span classtext-muted pl-2>string/span>/div>p>When an order is locked, it cannot be modified or sent until it is unlocked. Possible values: code>locked/code> or code>unlocked/code>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>source/strong>span classtext-muted pl-2>string/span>/div>p>A description of how the order was created in Webshipper. Possible values: api, manual or csv/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tags/strong>span classtext-muted pl-2>array/span>/div>p>Array of strings used to tag an order/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>error_class/strong>span classtext-muted pl-2>string/span>/div>p>A string like address or carrier_downtime describe which type of error caused the order to fail/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>slip_printed/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>label_printed/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>create_shipment_automatically/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_activity/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_status_event/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_rate_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>csv_upload_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>*order_channel/strong>div classtext-muted>has_one/div>br>a href#order_channels>order_channels/a>.strong>shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.strong>error_type/strong>div classtext-muted>has_one/div>br>a href#error_types>error_types/a>.strong>printer_client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.strong>shipments/strong>div classtext-muted>has_many/div>br>a href#shipments>shipments/a>.strong>additional_attributes/strong>div classtext-muted>has_many/div>br>a href#additional_attributes>additional_attributes/a>.Has many relationship to AdditionalAttribute. To add AdditionalAttribute to orders, they must be created in a separate POST request and then assigned as a relationship to the order.strong>print_jobs/strong>div classtext-muted>has_many/div>br>a href#printer_jobs>printer_jobs/a>.strong>packages/strong>div classtext-muted>has_many/div>br>a href#packages>packages/a>.strong>events/strong>div classtext-muted>has_many/div>br>a href#events>events/a>.strong>attachments/strong>div classtext-muted>has_many/div>br>a href#attachments>attachments/a>.strong>documents/strong>div classtext-muted>has_many/div>br>a href#documents>documents/a>.strong>activities/strong>div classtext-muted>has_many/div>br>a href#activities>activities/a>.strong>status_events/strong>div classtext-muted>has_many/div>br>a href#activities>activities/a>.strong>returns/strong>div classtext-muted>has_many/div>br>a href#returns>returns/a>.strong>comments/strong>div classtext-muted>has_many/div>br>a href#comments>comments/a>.strong>stores/strong>div classtext-muted>has_many/div>br>a href#stores>stores/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>ext_ref/code>, code>sorting_id/code>, code>created_at/code>, code>updated_at/code>, code>status/code>, code>slip_printed/code>, code>label_printed/code>, code>visible_ref/code>, code>lock_state/code>, code>order_channel/code>, code>order_channel_id/code>, code>shipping_rate/code>, code>shipping_rate_id/code>, code>carrier/code>, code>sku/code>, code>free_text/code>, code>tag/code>, code>delivery_country_code/code>, code>activity_type/code>, code>order_lines/code>, code>billing_contact/code>, code>billing_company/code>, code>billing_email/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/orders/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/orders/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/orders/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/orders/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/orders/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idorders-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#orders_Full sample_samples idpills-orders-Full sample-tab roletab>Full sample/a>/li>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link  data-togglepill href#orders_Use cases_samples idpills-orders-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idorders_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/orders/12/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 12,    type: orders,    links: {      self: /v2/orders/12    },    attributes: {      order_channel_id: 2,      status: pending,      ext_ref: ID123,      visible_ref: a7g54,      drop_point: {        id: null,        order_id: 12,        drop_point_id: 141122,        name: Cirkel K on Testroad,        address_1: Test road 11,        address_2: null,        zip: 8000,        city: Århus C,        country_code: DK,        state: null,        created_at: null,        updated_at: null,        phone: 99999999,        email: null,        longitude: null,        latitude: null,        carrier_code: null,        routing_code: RTC      },      original_shipping: {        id: null,        order_id: 12,        shipping_code: EXPRESS,        shipping_name: Express shipping,        price: 99.0,        vat_percent: 25.0,        created_at: null,        updated_at: null      },      order_lines:         {          id: 2,          sku: ZB420,          description: Zebra GK420d label printer,          quantity: 1,          location: LOC 3563-67,          tarif_number: 844332,          country_of_origin: DK,          unit_price: 24.0,          vat_percent: 25.0,          order_id: 12,          status: null,          ext_ref: 342342,          created_at: null,          updated_at: null,          package_id: null,          weight: 500.0,          weight_unit: g,          discount_value: 0.0,          discount_type: fixed,          is_virtual: false,          dangerous_goods_details: {          },          discounted_unit_price: 24.0,          additional_attributes: {            color: blue,            in_stock: 1          }        }      ,      delivery_address: {        id: null,        att_contact: Awesome developer,        company_name: Webshipper,        address_1: lyngbygade 8,        address_2: null,        zip: 8600,        city: Silkeborg,        country_code: DK,        state: null,        phone: 80808080,        email: invoice@webshipper.com,        created_at: null,        updated_at: null,        address_type: recipient,        vat_no: null,        ext_location: null,        company_customs_numbers: {        },        formatted_recipient: Webshipper att. Awesome developer,        voec: null,        eori: null,        sprn: null,        ioss: null,        fda: null,        duns: null,        personal_customs_no: null      },      sender_address: {        id: null,        att_contact: ,        company_name: Printers inc.,        address_1: Michael Drewsensvej 21,        address_2: null,        zip: 8000,        city: Århus,        country_code: DK,        state: null,        phone: null,        email: null,        created_at: null,        updated_at: null,        address_type: recipient,        vat_no: null,        ext_location: null,        company_customs_numbers: {        },        formatted_recipient: Printers inc.,        voec: null,        eori: null,        sprn: null,        ioss: null,        fda: null,        duns: null,        personal_customs_no: null      },      billing_address: {        id: null,        att_contact: Awesome developer,        company_name: Webshipper,        address_1: lyngbygade 8,        address_2: null,        zip: 8600,        city: Silkeborg,        country_code: DK,        state: null,        phone: 80808080,        email: invoice@webshipper.com,        created_at: null,        updated_at: null,        address_type: recipient,        vat_no: null,        ext_location: null,        company_customs_numbers: {        },        formatted_recipient: Webshipper att. Awesome developer,        voec: null,        eori: null,        sprn: null,        ioss: null,        fda: null,        duns: null,        personal_customs_no: null      },      sold_from_address: null,      currency: DKK,      internal_comment: Internal comment,      external_comment: We need the order ASAP. If no one on the office, place the package in front of the door,      error_message: null,      updated_at: null,      created_at: null,      lock_state: unlocked,      source: api,      tags:         PRIORITY,        BEFORE_10      ,      error_class: null,      slip_printed: null,      label_printed: null,      create_shipment_automatically: false,      latest_activity: null,      latest_status_event: null,      shipping_rate_id: null,      csv_upload_id: null    },    relationships: {      order_channel: {        links: {          self: /v2/orders/12/relationships/order_channel,          related: /v2/orders/12/order_channel        }      },      shipping_rate: {        links: {          self: /v2/orders/12/relationships/shipping_rate,          related: /v2/orders/12/shipping_rate        }      },      error_type: {        links: {          self: /v2/orders/12/relationships/error_type,          related: /v2/orders/12/error_type        }      },      printer_client: {        links: {          self: /v2/orders/12/relationships/printer_client,          related: /v2/orders/12/printer_client        }      },      shipments: {        links: {          self: /v2/orders/12/relationships/shipments,          related: /v2/orders/12/shipments        }      },      additional_attributes: {        links: {          self: /v2/orders/12/relationships/additional_attributes,          related: /v2/orders/12/additional_attributes        }      },      print_jobs: {        links: {          self: /v2/orders/12/relationships/print_jobs,          related: /v2/orders/12/print_jobs        }      },      packages: {        links: {          self: /v2/orders/12/relationships/packages,          related: /v2/orders/12/packages        }      },      events: {        links: {          self: /v2/orders/12/relationships/events,          related: /v2/orders/12/events        }      },      attachments: {        links: {          self: /v2/orders/12/relationships/attachments,          related: /v2/orders/12/attachments        }      },      documents: {        links: {          self: /v2/orders/12/relationships/documents,          related: /v2/orders/12/documents        }      },      activities: {        links: {          self: /v2/orders/12/relationships/activities,          related: /v2/orders/12/activities        }      },      status_events: {        links: {          self: /v2/orders/12/relationships/status_events,          related: /v2/orders/12/status_events        }      },      returns: {        links: {          self: /v2/orders/12/relationships/returns,          related: /v2/orders/12/returns        }      },      comments: {        links: {          self: /v2/orders/12/relationships/comments,          related: /v2/orders/12/comments        }      },      stores: {        links: {          self: /v2/orders/12/relationships/stores,          related: /v2/orders/12/stores        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>div aria-labelledbypills-home-tab classtab-pane fade show  idorders_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/orders/div>p classtext-muted>Creating an order with a drop point/p>pre>code classjson>{
  data: {
    type: orders,
    attributes: {
      drop_point: {
        drop_point_id: 12,
        address_1: Street 123,
        zip: 8600,
        city: Silkeborg,
        country_code: DK,
        carrier_code: DUMMY
      },
      delivery_address: {
        address_1: Lyngbygade 8,
        zip: 8600,
        city: Silkeborg,
        country_code: DK
      },
      sender_address: {
        address_1: Example street 2,
        zip: 7400,
        city: Herning,
        country_code: DK
      },
      order_lines: 
        {
          sku: ZB420,
          description: Zebra GK420d label printer,
          quantity: 1,
          location: LOC 3563-67,
          tarif_number: 844332,
          country_of_origin: DK,
          unit_price: 24.0,
          vat_percent: 25.0,
          order_id: 12,
          ext_ref: 342342,
          weight: 500.0,
          weight_unit: g,
          discount_value: 0.0,
          discount_type: fixed,
          discounted_unit_price: 24.0
        }
      
    },
    relationships: {
      order_channel: {
        data: {
          id: 9,
          type: order_channels
        }
      },
      shipping_rate: {
        data: {
          id: 6,
          type: shipping_rates
        }
      }
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idorder_channels stylemin-height: 700px;>h2>Order Channel/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/order_channels/div>div classmb-3>/div>p>An order channel models a specific integration with a webshop or ERP-system. Order channels are configured with attributes. During setup, additional_parameters can be used to support customer authorisation flow (like the OAuth2 Authorisation Code grant type).    /p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>channel_label/strong>span classtext-muted pl-2>string/span>/div>p>Label to identify the order channel./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>attrs/strong>span classtext-muted pl-2>array/span>/div>p>Array of hashed with keys: code>attr_key/code>, code>attr_value/code>, code>attr_name/code>, code>attr_type/code>, code>is_required/code>, code>only_visible_on_creation/code> /code>enums/code>. See      documentation for Local Attributes/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>additional_parameters/strong>span classtext-muted pl-2>object/span>/div>p>Optional hash, this is used when creating new order channels./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>slip_print_mode/strong>span classtext-muted pl-2>string/span>/div>p>Possible values: dont_print, print_immediately or print_with_shipment./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>return_label_print_mode/strong>span classtext-muted pl-2>string/span>/div>p>Possible values: dont_print, print_immediately./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_label_print_mode/strong>span classtext-muted pl-2>string/span>/div>p>Possible values: dont_print, print_immediately./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>document_print_mode/strong>span classtext-muted pl-2>string/span>/div>p>Possible values: dont_print, print_immediately./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>logo/strong>span classtext-muted pl-2>/span>/div>p>Base64 representation of the logo of the order channel./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>configuration_token/strong>span classtext-muted pl-2>/span>/div>p>Token to use for Webshipper modules. Tokens will only be generated for modules that require a configuration token./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sync_status/strong>span classtext-muted pl-2>integer/span>/div>p>Determines if the order channel is currently synchronising. Possible values are: code>synchronize/code>, code>suspended/code>, code>paused/code>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>failed_sync_count/strong>span classtext-muted pl-2>integer/span>/div>p>Shows if recent synchronisation events have failed./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>fulfill_automatically/strong>span classtext-muted pl-2>boolean/span>/div>p>Whether or not to fulfill the order in the original order channel when a shipment is created. Default: true/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>drop_point_limit/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>create_shipment_automatically/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>health/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>convert_currency_on_rate_quotes/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sync_additional_attributes_to_shipments/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>auto_order_import/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>has_configuration_token/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>order_channel_type/strong>div classtext-muted>has_one/div>br>a href#order_channel_types>order_channel_types/a>.strong>slip_template/strong>div classtext-muted>has_one/div>br>a href#slip_templates>slip_templates/a>.strong>sender_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>return_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>pickup_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>sold_from_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>default_printer_client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.strong>orders/strong>div classtext-muted>has_many/div>br>a href#orders>orders/a>.strong>shipping_rates/strong>div classtext-muted>has_many/div>br>a href#shipping_rates>shipping_rates/a>.strong>shipping_mappings/strong>div classtext-muted>has_many/div>br>a href#shipping_mappings>shipping_mappings/a>.strong>order_channel_sync_entries/strong>div classtext-muted>has_many/div>br>a href#order_channel_sync_entries>order_channel_sync_entries/a>.strong>additional_attributes/strong>div classtext-muted>has_many/div>br>a href#additional_attributes>additional_attributes/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>attr/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/order_channels/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/order_channels/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/order_channels/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/order_channels/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/order_channels/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idorder_channels-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#order_channels_Full sample_samples idpills-order_channels-Full sample-tab roletab>Full sample/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idorder_channels_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/order_channels/2/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 2,    type: order_channels,    links: {      self: /v2/order_channels/2    },    attributes: {      channel_label: My Shopify Shop,      attrs:         {          attr_key: shop_name,          attr_value: myshop.myshopify.com,          attr_name: Shop name,          attr_type: text,          description: null,          is_required: true,          only_visible_on_creation: false,          category: null,          priority: null,          enums:                   }      ,      additional_parameters: null,      slip_print_mode: print_immediately,      return_label_print_mode: print_immediately,      shipping_label_print_mode: print_immediately,      document_print_mode: print_immediately,      logo: null,      configuration_token: null,      sync_status: synchronize,      failed_sync_count: 0,      fulfill_automatically: true,      drop_point_limit: 10,      create_shipment_automatically: false,      health: {        health: 1,        health_1h: 1,        health_1d: 1,        health_1w: 1      },      convert_currency_on_rate_quotes: null,      sync_additional_attributes_to_shipments: false,      auto_order_import: false,      has_configuration_token: false    },    relationships: {      orders: {        links: {          self: /v2/order_channels/2/relationships/orders,          related: /v2/order_channels/2/orders        }      },      shipping_rates: {        links: {          self: /v2/order_channels/2/relationships/shipping_rates,          related: /v2/order_channels/2/shipping_rates        }      },      shipping_mappings: {        links: {          self: /v2/order_channels/2/relationships/shipping_mappings,          related: /v2/order_channels/2/shipping_mappings        }      },      order_channel_sync_entries: {        links: {          self: /v2/order_channels/2/relationships/order_channel_sync_entries,          related: /v2/order_channels/2/order_channel_sync_entries        }      },      order_channel_type: {        links: {          self: /v2/order_channels/2/relationships/order_channel_type,          related: /v2/order_channels/2/order_channel_type        }      },      slip_template: {        links: {          self: /v2/order_channels/2/relationships/slip_template,          related: /v2/order_channels/2/slip_template        }      },      sender_address: {        links: {          self: /v2/order_channels/2/relationships/sender_address,          related: /v2/order_channels/2/sender_address        }      },      return_address: {        links: {          self: /v2/order_channels/2/relationships/return_address,          related: /v2/order_channels/2/return_address        }      },      pickup_address: {        links: {          self: /v2/order_channels/2/relationships/pickup_address,          related: /v2/order_channels/2/pickup_address        }      },      sold_from_address: {        links: {          self: /v2/order_channels/2/relationships/sold_from_address,          related: /v2/order_channels/2/sold_from_address        }      },      default_printer_client: {        links: {          self: /v2/order_channels/2/relationships/default_printer_client,          related: /v2/order_channels/2/default_printer_client        }      },      additional_attributes: {        links: {          self: /v2/order_channels/2/relationships/additional_attributes,          related: /v2/order_channels/2/additional_attributes        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idorder_channel_accesses stylemin-height: 700px;>h2>Order Channel Access/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/order_channel_accesses/div>div classmb-3>/div>p>Grants a user access to an order channel. This has no effect if the user has been granted access to all order channels./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>h5>Relationships/h5>strong>order_channel/strong>div classtext-muted>has_one/div>br>a href#order_channels>order_channels/a>.strong>user/strong>div classtext-muted>has_one/div>br>a href#users>users/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/order_channel_accesses/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/order_channel_accesses/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/order_channel_accesses/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/order_channel_accesses/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/order_channel_accesses/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idorder_channel_accesses-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idorder_channel_types stylemin-height: 700px;>h2>Order Channel Type/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/order_channel_types/div>div classmb-3>/div>p>Order Channel Types are used to create Order Channels /p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>support_url/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>public_global_attrs/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>list_logo/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>module_link/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>can_autofulfill/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>can_limit_drop_points/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_rate_quoting/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>uses_scheduled_import/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_time_interval_import/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_statuses_import/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_id_import/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_vat_in_checkout/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>hide/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>local_attrs/strong>div classtext-muted>has_many/div>br>a href#local_attrs>local_attrs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>by_name/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/order_channel_types/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/order_channel_types/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idorder_channel_types-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idorder_lines stylemin-height: 700px;>h2>Order Line/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/order_lines/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>sku/strong>span classtext-muted pl-2>string/span>/div>p>Stock Keeping Unit of the order line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>Description of the goods/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>quantity/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>Quantity of goods/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>location/strong>span classtext-muted pl-2>string/span>/div>p>The warehouse location of the items./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tarif_number/strong>span classtext-muted pl-2>string/span>/div>p>HS Tarif code for paperless customs/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>country_of_origin/strong>span classtext-muted pl-2>string/span>/div>p>The country of origin of the goods./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>unit_price/strong>span classtext-muted pl-2>float/span>/div>p>The unit price of goods in the currency of the order/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>package_id/strong>span classtext-muted pl-2>integer/span>/div>p>Whether the items are associated with a parcel of a shipment./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>discounted_unit_price/strong>span classtext-muted pl-2>/span>/div>p>The unit price after discounts has been applied in the currency of the order/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>discount_value/strong>span classtext-muted pl-2>float/span>/div>p>The discount for the order line, in the type given by discount_type/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>discount_type/strong>span classtext-muted pl-2>integer/span>/div>p>The type of discount, eg. percent or fixed/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>vat_percent/strong>span classtext-muted pl-2>float/span>/div>p>The VAT rate in percentage./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>integer/span>/div>p>Possible enum values: pending, dispatched or returned/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ext_ref/strong>span classtext-muted pl-2>string/span>/div>p>External reference of the order line./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight/strong>span classtext-muted pl-2>float/span>/div>p>Weight per unit./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight_unit/strong>span classtext-muted pl-2>string/span>/div>p>Weight unit. Possible values: code>oz/code>, code>g/code>, code>lbs/code>, code>kg/code>. Defaults to code>g/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_virtual/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dangerous_goods_details/strong>span classtext-muted pl-2>object/span>/div>p>Optional object of key value pairs used for providing information of dangerous goods. For use with DGOffice, use keys: article_no, package_type_id and packaging_instruction_type./p>hr>/div>h5>Relationships/h5>strong>package/strong>div classtext-muted>has_one/div>br>a href#packages>packages/a>.strong>*order/strong>div classtext-muted>has_one/div>br>a href#orders>orders/a>.strong>additional_attributes/strong>div classtext-muted>has_many/div>br>a href#additional_attributes>additional_attributes/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idorder_lines-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idpackages stylemin-height: 700px;>h2>Package/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/packages/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>weight/strong>span classtext-muted pl-2>requirednumber/span>/div>p>Weight of the package/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight_unit/strong>span classtext-muted pl-2>requiredenum/span>/div>p>One of g, oz, lbs and kg /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dimensions/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_attributes/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>add_ons/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>colli_type/strong>span classtext-muted pl-2>string/span>/div>p>Colli type of the package. Can be used to specify if the colli is a pallet, package, letter, etc. Should use values from the supported_colli_types field from the service quote/list response for the given service./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>predefined_barcode/strong>span classtext-muted pl-2>/span>/div>p>A predefined SSCC barcode. Can be used if the barcode already has been created outside of Webshipper./p>hr>/div>h5>Relationships/h5>strong>shipment/strong>div classtext-muted>has_one/div>br>a href#shipments>shipments/a>.strong>order_lines/strong>div classtext-muted>has_many/div>br>a href#order_lines>order_lines/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/packages/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/packages/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/packages/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idpackages-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idpickups stylemin-height: 700px;>h2>Pickup/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/pickups/div>div classmb-3>/div>p>Pickups facilitates the booking of a pickup from a given carrier. Not all carriers supports pickup./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>pickup_instruction/strong>span classtext-muted pl-2>text/span>/div>p>Instruction to the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>pickup_location_close_time/strong>span classtext-muted pl-2>datetime/span>/div>p>When the pickup location is closing./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>pickup_time/strong>span classtext-muted pl-2>datetime/span>/div>p>The time you want the carrier to arrive at the pickup address./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>reference/strong>span classtext-muted pl-2>string/span>/div>p>The reference returned by the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>integer/span>/div>p>Decides if the pickup is code>requested/code> or code>cancelled/code>. To cancel a pickup you must update the status to cancelled. /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_address/strong>span classtext-muted pl-2>/span>/div>p>The address where the shipments must be picked up./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier/strong>span classtext-muted pl-2>/span>/div>p>The carrier that should pickup the shipments./p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>shipping_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>shipments/strong>div classtext-muted>has_many/div>br>a href#shipments>shipments/a>.strong>additional_attributes/strong>div classtext-muted>has_many/div>br>a href#additional_attributes>additional_attributes/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/pickups/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/pickups/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/pickups/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/pickups/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/pickups/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idpickups-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idbulk_printer_jobs stylemin-height: 700px;>h2>Print Bulk Slips/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/bulk_printer_jobs/div>div classmb-3>/div>p>Bulk add slips to the printer queue/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>ids/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>model_type/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>printer_client_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/bulk_printer_jobs/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/bulk_printer_jobs/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/bulk_printer_jobs/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/bulk_printer_jobs/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/bulk_printer_jobs/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idbulk_printer_jobs-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idprintables stylemin-height: 700px;>h2>Printable/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/printables/div>div classmb-3>/div>p>/p>h5>Attributes/h5>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printables/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printables/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/printables/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/printables/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/printables/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idprintables-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idprinters stylemin-height: 700px;>h2>Printer/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/printers/div>div classmb-3>/div>p>Printers are loaded automatically when connecting to your account from the Webshipper Silent Printer application./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>Name of the printer./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>active/strong>span classtext-muted pl-2>boolean/span>/div>p>Determines if the printer is configured on the printer station/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>last_connected/strong>span classtext-muted pl-2>datetime/span>/div>p>Last connection time/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>paper_width/strong>span classtext-muted pl-2>float/span>/div>p>Paper width/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>paper_height/strong>span classtext-muted pl-2>float/span>/div>p>Paper height/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>rotate_print_180/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printers/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printers/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idprinters-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idprinter_clients stylemin-height: 700px;>h2>Printer Client/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/printer_clients/div>div classmb-3>/div>p>Printer clients are created automatically when connecting Webshipper Silent Printer and should not be created manually./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>uuid/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Unique ID of the printer client/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>approved/strong>span classtext-muted pl-2>boolean/span>/div>p>DEPRECATED/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>alias/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Defaults to the host name of the machine running the client /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_online/strong>span classtext-muted pl-2>boolean/span>/div>p>Shows if the printer client is online/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>last_connected/strong>span classtext-muted pl-2>datetime/span>/div>p>Shows when the printer client was last connected/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>prevent_multiple_shipments/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>label_printer/strong>div classtext-muted>has_one/div>br>a href#printers>printers/a>.strong>zpl_printer/strong>div classtext-muted>has_one/div>br>a href#printers>printers/a>.strong>document_printer/strong>div classtext-muted>has_one/div>br>a href#printers>printers/a>.strong>location/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>printers/strong>div classtext-muted>has_many/div>br>a href#printers>printers/a>.strong>order_channels/strong>div classtext-muted>has_many/div>br>a href#order_channels>order_channels/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printer_clients/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printer_clients/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/printer_clients/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idprinter_clients-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idprinter_jobs stylemin-height: 700px;>h2>Printer Job/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/printer_jobs/div>div classmb-3>/div>p>Printer Jobs are used to print documents, labels etc. After a Printer Job is created, it will the sent to the printer client installed on one of your machines. After the printer client has accepted the job, it will mark the Printer Job as completed./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>completed/strong>span classtext-muted pl-2>boolean/span>/div>p>This will return as code>true/code> when the printer client has accepted the job./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>error/strong>span classtext-muted pl-2>string/span>/div>p>Any error message that resulted./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Base64 encoding if the associated printable, must the explicitly included in em>fields/em> query parameter to be included/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>try_count/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>initiator/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>options/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>printer_client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.strong>printer/strong>div classtext-muted>has_one/div>br>a href#printers>printers/a>.strong>printable/strong>div classtext-muted>has_one/div>br>Polymorphic.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>printer_client_id/code>, code>created_at/code>, code>completed/code>, code>error/code>, code>try_count/code>, code>printer_id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printer_jobs/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printer_jobs/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/printer_jobs/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/printer_jobs/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/printer_jobs/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idprinter_jobs-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idrate_quotes_items stylemin-height: 700px;>h2>Quote Object/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/rate_quotes_items/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>price/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Price in some currency/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idrate_quotes_items-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idrate_quotes stylemin-height: 700px;>h2>Rate Quote/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/rate_quotes/div>div classmb-3>/div>p>Get rates for an order channel. This provides a list of all shipping rates whose conditions matched the input. Quotes are not persistent. The id field is always returned as 1 and should be ignored./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>quotes/strong>span classtext-muted pl-2>array/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Array of quotes/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>success/strong>span classtext-muted pl-2>/span>/div>p>div classbadge badge-warning mr-3>Read only/div>DEPRECATED. The request will return an error response if the quote failed./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>delivery_address/strong>span classtext-muted pl-2>requiredobject/span>/div>p>Delivery address for the quote. Flattened resource of Shipping Address/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>price/strong>span classtext-muted pl-2>integer/span>/div>p>The total price of the items/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight/strong>span classtext-muted pl-2>requiredfloat/span>/div>p>Weight for the quote./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>weight_unit/strong>span classtext-muted pl-2>requiredenum/span>/div>p>The weight unit. Possible values: g, kg, lbs, oz./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>height/strong>span classtext-muted pl-2>float/span>/div>p>Height for the quote. The unit must match the unit you are using for shipping rate configurations./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>length/strong>span classtext-muted pl-2>float/span>/div>p>Length for the quote. The unit must match the unit you are using for shipping rate configurations./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>width/strong>span classtext-muted pl-2>float/span>/div>p>Width for the quote. The unit must match the unit you are using for shipping rate configurations./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dimensions_unit/strong>span classtext-muted pl-2>/span>/div>p>Dimensions unit. Possible values: cm, m, in, ft/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sender_address/strong>span classtext-muted pl-2>object/span>/div>p>Delivery address for the quote. Flattened resource of Shipping Address/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>items/strong>span classtext-muted pl-2>array/span>/div>p>Array of items, each item should have fields code>quantity/code>, code>sku/code>, code>description/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>The id of the order channel for which to get shipping rates./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>currency/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>include_hidden/strong>span classtext-muted pl-2>boolean/span>/div>p>Also include shipping rates which are normally hidden during checkout./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_return/strong>span classtext-muted pl-2>boolean/span>/div>p>Set to true to quote for return rates. If false standard rates are quoted. Default: false./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>additional_attributes/strong>span classtext-muted pl-2>/span>/div>p>Possibility to add hash of additional attributes for filtering./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>filter_by_currency/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/rate_quotes/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idrate_quotes-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#rate_quotes_Full sample_samples idpills-rate_quotes-Full sample-tab roletab>Full sample/a>/li>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link  data-togglepill href#rate_quotes_Use cases_samples idpills-rate_quotes-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idrate_quotes_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/rate_quotes/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 1,    type: rate_quotes,    links: {      self: /v2/rate_quotes/1    },    attributes: {      quotes:         {          price: 99,          carrier_name: Test carrier,          currency: EUR,          carrier_logo: !--BASE64-->,          shipping_rate: {            name: Test name,            carrier_id: 4,            carrier_service_code: testcode          }        }      ,      success: true,      delivery_address: {        country_code: DK      },      price: 99,      weight: 10,      weight_unit: null,      height: 56,      length: 12,      width: 35,      dimensions_unit: null,      sender_address: {        country_code: NO      },      items:         {          quantity: 2,          description: Black T-shirts,          sku: BLK 238        }      ,      order_channel_id: 12,      currency: null,      include_hidden: null,      is_return: null,      additional_attributes: null,      filter_by_currency: null    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>div aria-labelledbypills-home-tab classtab-pane fade show  idrate_quotes_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/rate_quotes/div>p classtext-muted>Order Channel Rate Quotes can quote an order channel for matching shipping rates. These quotes are used to display shipping options in e-commerce systems./p>pre>code classjson>{
  data: {
    type: rate_quotes,
    attributes: {
      order_channel_id: 16,
      price: 199,
      weight: 100,
      delivery_address: {
        zip: 7400,
        country_code: DK
      },
      items: 
        {
          quantity: 5,
          sku: sku123
        }
      
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreports stylemin-height: 700px;>h2>Report/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/reports/div>div classmb-3>/div>p>Reports are generated by using Report Types which specify how a report should look and which records to include in the report./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>start_time/strong>span classtext-muted pl-2>datetime/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>end_time/strong>span classtext-muted pl-2>datetime/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>output_formats/strong>span classtext-muted pl-2>array/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>parameters/strong>span classtext-muted pl-2>object/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>string/span>/div>p>div classbadge badge-warning mr-3>Read only/div>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>pdf_download_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>xml_download_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>csv_download_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>json_download_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>xlsx_download_url/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>failed/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_ids/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>error_message/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>report_type/strong>div classtext-muted>has_one/div>br>a href#report_types>report_types/a>.strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>print_jobs/strong>div classtext-muted>has_many/div>br>a href#printer_jobs>printer_jobs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/reports/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/reports/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/reports/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/reports/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/reports/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreports-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreport_types stylemin-height: 700px;>h2>Report Type/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/report_types/div>div classmb-3>/div>p>This resource acts a template for creating resource./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>columns/strong>span classtext-muted pl-2>array/span>/div>p>Array of objects with keys code>header/code> and code>content/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>parameters/strong>span classtext-muted pl-2>array/span>/div>p>Array of objects with keys code>parameter_key/code> and code>parameter_value/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>resource/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>header_columns/strong>span classtext-muted pl-2>array/span>/div>p>Array of objects with keys code>header/code> and code>content/code> that will be used to display the header content of the report/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>footer_content/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>conditions/strong>span classtext-muted pl-2>array/span>/div>p>Array of objects describing how to load the resources. Contains keys code>condition_key/code>, code>condition_operator/code>, code>condition_value/code>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>include_deleted/strong>span classtext-muted pl-2>boolean/span>/div>p>If true the report will included deleted records. Default: code>false/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>use_carrier_eod/strong>span classtext-muted pl-2>boolean/span>/div>p>When set to true it will attempt to fetch the end of day list directly from the carrier. When this option is enabled, only pdf reports are available./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>schedule/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>default_format/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>mail_on_run/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>mail/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/report_types/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/report_types/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/report_types/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/report_types/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/report_types/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreport_types-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idprinter_requeue_jobs stylemin-height: 700px;>h2>Requeueable Printer Jobs/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/printer_requeue_jobs/div>div classmb-3>/div>p>Find and requeue failed printer jobs within the given timeframe/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>start_time/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>end_time/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>job_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>mark_as_complete/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printer_requeue_jobs/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/printer_requeue_jobs/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/printer_requeue_jobs/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/printer_requeue_jobs/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/printer_requeue_jobs/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idprinter_requeue_jobs-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreturn_causes stylemin-height: 700px;>h2>Return Causes/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/return_causes/div>div classmb-3>/div>p>Description of the cause/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>require_comment/strong>span classtext-muted pl-2>boolean/span>/div>p>Does the cause require a comment/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>limit_refund_methods/strong>span classtext-muted pl-2>boolean/span>/div>p>Does the cause limit refund methods/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>support_image_required/strong>span classtext-muted pl-2>boolean/span>/div>p>Does the cause support image required/p>hr>/div>h5>Relationships/h5>strong>portal/strong>div classtext-muted>has_one/div>br>a href#return_portals>return_portals/a>.strong>refund_methods/strong>div classtext-muted>has_many/div>br>a href#return_refund_methods>return_refund_methods/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_causes/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_causes/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/return_causes/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/return_causes/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/return_causes/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreturn_causes-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreturn_lines stylemin-height: 700px;>h2>Return Lines/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/return_lines/div>div classmb-3>/div>p>Read only resource for return lines./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>cause_description/strong>span classtext-muted pl-2>text/span>/div>p>Description of the cause/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>quantity/strong>span classtext-muted pl-2>integer/span>/div>p>Quantity of the return line/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>refund_method/strong>span classtext-muted pl-2>/span>/div>p>Refund method for the return line/p>hr>/div>h5>Relationships/h5>strong>return/strong>div classtext-muted>has_one/div>br>a href#returns>returns/a>.strong>cause/strong>div classtext-muted>has_one/div>br>a href#return_causes>return_causes/a>.strong>order_line/strong>div classtext-muted>has_one/div>br>a href#order_lines>order_lines/a>.strong>refund_method/strong>div classtext-muted>has_one/div>br>a href#return_refund_methods>return_refund_methods/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_lines/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_lines/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/return_lines/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/return_lines/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/return_lines/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreturn_lines-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreturns stylemin-height: 700px;>h2>Return Order/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/returns/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>string/span>/div>p>One of pending, sent, arrived, processed, error or approved/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>error_message/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>return_lines/strong>span classtext-muted pl-2>requiredarray/span>/div>p>Array of ReturnLine objects. Contains fields order_line_id, quantity, cause_id, cause_description and images. When creating, images should be an array of data uri containing the base64 encoding of the image, example: em>data:image/jpeg;base64,AAQSkZJ......RgABAQEAlgCWAAD/em>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>/span>/div>p>Base 64 encoding of return slip/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>secret/strong>span classtext-muted pl-2>string/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Read only token for publicly accessing status of the return order/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>internal_comment/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_activity/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>internal_session_id/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>order/strong>div classtext-muted>has_one/div>br>a href#orders>orders/a>.strong>portal/strong>div classtext-muted>has_one/div>br>a href#return_portals>return_portals/a>.strong>shipping_method/strong>div classtext-muted>has_one/div>br>a href#return_shipping_methods>return_shipping_methods/a>.strong>shipment/strong>div classtext-muted>has_one/div>br>a href#shipments>shipments/a>.strong>activities/strong>div classtext-muted>has_many/div>br>a href#activities>activities/a>.strong>events/strong>div classtext-muted>has_many/div>br>a href#events>events/a>.strong>comments/strong>div classtext-muted>has_many/div>br>a href#comments>comments/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>secret/code>, code>activity_type/code>, code>status/code>, code>portal_id/code>, code>free_text/code>, code>return_causes/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/returns/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/returns/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/returns/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/returns/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/returns/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreturns-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#returns_Creating Return_samples idpills-returns-Creating Return-tab roletab>Creating Return/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idreturns_Creating Return_samples roletabpanel>div classtext-light>span classbadge badge-primary>/span>https://<account name>.api.webshipper.io/v2/returns/1/div>p classtext-muted>/p>pre>code classjson>{  data: {    id: 1,    type: returns,    links: {      self: /v2/returns/1    },    attributes: {      status: pending,      error_message: null,      return_lines:         {          id: null,          return_id: 1,          order_line_id: 6436,          cause_id: 53,          cause_description: It was too small,          quantity: 1,          deleted_at: null,          created_at: null,          updated_at: null,          images:           ,          refund_method: {            id: null,            name: Gift card,            description: null,            portal_id: null,            created_at: null,            updated_at: null,            allowed_days: null,            payment_required: false,            excluded_skus:                       }        }      ,      secret: null,      latest_activity: null,      updated_at: null,      created_at: null,      order_channel_id: null,      internal_session_id: null    },    relationships: {      activities: {        links: {          self: /v2/returns/1/relationships/activities,          related: /v2/returns/1/activities        }      },      events: {        links: {          self: /v2/returns/1/relationships/events,          related: /v2/returns/1/events        }      },      comments: {        links: {          self: /v2/returns/1/relationships/comments,          related: /v2/returns/1/comments        }      },      order: {        links: {          self: /v2/returns/1/relationships/order,          related: /v2/returns/1/order        }      },      portal: {        links: {          self: /v2/returns/1/relationships/portal,          related: /v2/returns/1/portal        }      },      shipping_method: {        links: {          self: /v2/returns/1/relationships/shipping_method,          related: /v2/returns/1/shipping_method        }      },      shipment: {        links: {          self: /v2/returns/1/relationships/shipment,          related: /v2/returns/1/shipment        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreturn_portals stylemin-height: 700px;>h2>Return Portal/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/return_portals/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>custom_style/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_methods/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>translations/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>locale/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>allowed_days_since_dispatch/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>send_immediately/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>static_notice_email/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_logo/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>logo/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>force_single_page/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>optional_return_cause/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>new_mail_template/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>new_confirmation_mail_template/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email_address_source/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email_address_resource_options/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>finished_stripe_setup/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>order_channel/strong>div classtext-muted>has_one/div>br>a href#order_channels>order_channels/a>.strong>slip_template/strong>div classtext-muted>has_one/div>br>a href#slip_templates>slip_templates/a>.strong>mail_template/strong>div classtext-muted>has_one/div>br>a href#mail_templates>mail_templates/a>.strong>confirmation_mail_template/strong>div classtext-muted>has_one/div>br>a href#mail_templates>mail_templates/a>.strong>return_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>returns/strong>div classtext-muted>has_many/div>br>a href#returns>returns/a>.strong>causes/strong>div classtext-muted>has_many/div>br>a href#return_causes>return_causes/a>.strong>refund_methods/strong>div classtext-muted>has_many/div>br>a href#return_refund_methods>return_refund_methods/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_portals/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_portals/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/return_portals/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/return_portals/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/return_portals/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreturn_portals-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idreturn_shipping_methods stylemin-height: 700px;>h2>Return Shipping Method/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/return_shipping_methods/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>excluded_skus/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>excluded_zip_codes/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>excluded_countries/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>portal/strong>div classtext-muted>has_one/div>br>a href#return_portals>return_portals/a>.strong>shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_shipping_methods/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/return_shipping_methods/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/return_shipping_methods/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/return_shipping_methods/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/return_shipping_methods/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idreturn_shipping_methods-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idservice_quotes stylemin-height: 700px;>h2>Service Quote/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/service_quotes/div>div classmb-3>/div>p>Service Quotes are used to find suitable services by quoting the carriers directly./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>success/strong>span classtext-muted pl-2>boolean/span>/div>p>div classbadge badge-warning mr-3>Read only/div>True if quote was successful/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_id/strong>span classtext-muted pl-2>requiredinteger/span>/div>p>The id of the carrier to quote/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_code/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>send_time/strong>span classtext-muted pl-2>requireddatetime/span>/div>p>ISO 8601 formatted/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>send_date/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>packages/strong>span classtext-muted pl-2>requiredarray/span>/div>p>Array of objects, each containing key code>weight/code>. At least one package is required./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>delivery_address/strong>span classtext-muted pl-2>requiredobject/span>/div>p>Delivery address for the quote/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sender_address/strong>span classtext-muted pl-2>requiredobject/span>/div>p>Sender address for the quote/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>services/strong>span classtext-muted pl-2>array/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Read only. Populated in response with an array of objects containing the following keys: ul classlist-doc> li>code>service_name/code>/li> li>code>service_code/code>/li> li>code>is_return/code>/li>   li>code>supports_paperless/code>/li>   li>code>requires_drop_point/code>/li>   li>code>cost_price/code>/li>   li>code>currency/code>/li>   li>code>vat_percent/code>/li>   li>code>estimated_delivery_date_from/code>/li>   li>code>estimated_delivery_date_to/code>/li>   li>  code>add_ons/code>div classtext-muted>Array containing objects/div>  ul classlist-doc>    li>code>add_on_name/code>/li>    li>code>add_on_code/code>/li>  /ul>/li>   li>code>parameters/code>/li>div classtext-muted>Array containing objects/div>   ul classlist-doc>    li>code>attr_name/code>/li>    li>code>attr_key/code>/li>    li>code>attr_type/code>/li>   /ul>   li>code>country_combinations/code>/li>   li>code>barcode_requirement/code>/li>   li>code>waybill_requirement/code>/li>   li>code>booking_quote_info/code>/li>   li>code>supported_colli_types/code>/li>/ul>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>add_ons/strong>span classtext-muted pl-2>/span>/div>p>Carrier add-ons for the quote/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_attributes/strong>span classtext-muted pl-2>/span>/div>p>Service attributes for the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_return/strong>span classtext-muted pl-2>/span>/div>p>Determines if you are quoting for return (inbound) services or standard (outbound) services./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dutiable/strong>span classtext-muted pl-2>/span>/div>p>Determines if the goods for the quote are dutiable/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>cost_sheet_id/strong>span classtext-muted pl-2>/span>/div>p>Used if you want only a price from a specific cost sheet/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>timeout/strong>span classtext-muted pl-2>/span>/div>p>Timeout for request in seconds. Will default to 15 seconds/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/service_quotes/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idservice_quotes-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#service_quotes_Use cases_samples idpills-service_quotes-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idservice_quotes_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/service_quotes/div>p classtext-muted>Query available services by carrier ID. Assuming a Carrier exists with id 1./p>pre>code classjson>{
  data: {
    type: service_quotes,
    attributes: {
      carrier_id: 1,
      is_return: false,
      send_time: 2025-09-10T06:27:38+02:00,
      delivery_address: {
        address_1: Søndergade 2B,
        zip: 8600,
        city: Silkeborg,
        country_code: DK
      },
      sender_address: {
        address_1: Lyngbygade 8,
        zip: 8600,
        city: Silkeborg,
        country_code: DK
      },
      packages: 
        {
          weight: 500,
          weight_unit: g,
          dimensions: {
            width: 15,
            length: 15,
            height: 15,
            unit: cm
          }
        }
      
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idshipments stylemin-height: 700px;>h2>Shipment/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/shipments/div>div classmb-3>/div>p>When a shipment is created, a booking is made with the carrier.    Once shipments have been created only packages can be modified. Existing packages can be updated and packages can be added or removed.    Creating a shipment with only a single relationship to an order will populate the shipment with attributes from the order.    This will result in a single package containing all of the order lines of the order. Creating multiple shipments from the same order will create shipments with empty packages with the default weight of 1000g.br/>br/>strong>Carrier, carrier service, service attributes and add-ons/strong> can either be assigned manually by filling in the respective relations and attributes or by using shipping rates. Shipping rates are pre-configurations of these relations and attribute, and thus you are able to omit all of these relations and attributes by using shipping rates.br/>br/>strong>All addresses, customs details etc. can be omitted/strong> by assigning an order relation to the shipment, and hence all of this information will be fetched directly from the order. Once the shipment has been sent, the order status will be automatically updated.br/>br/>strong>Updating a shipment/strong>br />Only the below fields are updateable. Shipment updates are intended for making smaller changes to a shipment before shipping time, i.e. adding or removing a package or pallet, changing number of exchange pallets, etc.If you need to make larger changes to a shipment you should instead delete the shipment and create a new one. Please note that deleting the shipment in Webshipper might not cancel the shipment with the carrier and as such might still incur charges from the carrier.ul>      li>fulfill_immediately/li>li>packages/li>li>service_attributes/li>li>add_ons/li>li>included_documents/li>li>status/li>li>comment/li>/ul>Please note that when updating shipments you should only include fields that you wish to change, and if you only wish to change part of a field, i.e. add a package to an existing set of packages, you should include all current data.For adding a package that means you should include the array of packages as it is before the change, remember to include ids for each existing package. New packages should not have an id. If you leave out ids for an existing object it will be deleted and recreated, this might result in new barcodes and other changes.You can see an example of updating package data in the use cases tab to the right./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>reference/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The reference you want to identify the shipment form. For example order number./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>comment/strong>span classtext-muted pl-2>text/span>/div>p>An optional comment for the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_code/strong>span classtext-muted pl-2>string/span>/div>p>The carriers service code. This should only be assigned if you are not using a shipping rate./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_return/strong>span classtext-muted pl-2>boolean/span>/div>p>Determines whether the shipment is a return shipment./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>packages/strong>span classtext-muted pl-2>requiredarray/span>/div>p>Flattened array of packages to be sent. At least one package is mandatory. For structure refer to Package entity/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>delivery_address/strong>span classtext-muted pl-2>requiredobject/span>/div>p>Flattened Shipping Address representing the delivery address for the shipment. br>strong>Duplicated from order if order relation given./strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sender_address/strong>span classtext-muted pl-2>requiredobject/span>/div>p>Flattened Shipping Address representing the sender address of shipment. br>strong>Duplicated from order if order relation given./strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>billing_address/strong>span classtext-muted pl-2>object/span>/div>p>Flattened Shipping Address representing the billing address of shipment. Duplicated from delivery address if empty. br>strong>Duplicated from order if order relation given./strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sold_from_address/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>pickup_address/strong>span classtext-muted pl-2>object/span>/div>p>Flattened Shipping Address representing the pickup address of shipment. Is necessary for some carriers. This is duplicated from sender address if empty. br>strong>Duplicated from order if order relation given./strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>return_address/strong>span classtext-muted pl-2>object/span>/div>p>Flattened Shipping Address represnting return addres of shipment. Will be duplicated from sender address if empty ( Not used by all carriers ). br>strong>Duplicated from order if order relation given./strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_attributes/strong>span classtext-muted pl-2>array/span>/div>p>Array of hashes to assign parameters for any specific carrier service. It is only required if you are strong>not/strong> using shipping rates and the service has additional required parameters. The hash must have the keys attr_key and attr_value. The type of attr_value should match the attr_type defined by the parameter. To see all possible attributes, please see the list of parameters from the carrier service.strongShould only be assigned if you are not using a shipping rate/strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>add_ons/strong>span classtext-muted pl-2>array/span>/div>p>Array of add-ons. Add-ons are simply arrays of strings. To see possible add-ons, please refer to the carrier services.strong>Should only be assigned if you are not using a shipping rate/strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sms_notification/strong>span classtext-muted pl-2>/span>/div>p>Must be passed if the carrier should be allowed to send SMS notifications. It should be assigned with a hash including the key phone containing the phone number to be notified.strong>Should only be assigned if you are not using a shipping rate/strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email_notification/strong>span classtext-muted pl-2>/span>/div>p>Must be passed if the carrier should be allowed to send e-mail notifications. It should be assigned with a hash including the key email containing the e-mail address to be notified.strong>Should only be assigned if you are not using a shipping rate/strong>./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>included_documents/strong>span classtext-muted pl-2>/span>/div>p>Flattened array of Document - can be used to upload documents to the shipment which will be sent to the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>drop_point/strong>span classtext-muted pl-2>/span>/div>p>Flattened Drop Point - should only be assigned if you are sending to a drop point./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tracking_links/strong>span classtext-muted pl-2>array/span>/div>p>An array of objects with the keys:      ul>        li>code>url/code>: The full URL to the tracking page./li>        li>code>number/code>: The tracking identifier./li>        li>code>latest_transit_event/code>: The latest tracking/transit event. Same options as Tracking Event statuses./li>        li>code>tracking_events/code>: Array of objects. Object has same attributes as the Tracking Event resource/li>      /ul>      /p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>fulfill_immediately/strong>span classtext-muted pl-2>/span>/div>p>Deprecated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>test_mode/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dutiable/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ext_ref/strong>span classtext-muted pl-2>string/span>/div>p>The external (carrier) reference/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>original_shipment_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>send_time/strong>span classtext-muted pl-2>datetime/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_update_time/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>supports_updates/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>additional_attributes/strong>span classtext-muted pl-2>/span>/div>p>Flattened hash with optional key/value pairs./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>cost_price/strong>span classtext-muted pl-2>float/span>/div>p>The cost price of the shipment, either directly from the carrier or from a cost sheet/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sales_price/strong>span classtext-muted pl-2>float/span>/div>p>The price presented to the customer in checkout/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>currency/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>manual_order_shipment_creation/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_type_name/strong>span classtext-muted pl-2>string/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Webshipper defined name of the carrier type/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_alias/strong>span classtext-muted pl-2>string/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Carrier alias set by the user in Webshipper/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_id/strong>span classtext-muted pl-2>integer/span>/div>p>div classbadge badge-warning mr-3>Read only/div>ID of the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>invoice_settings/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_activity/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_status_event/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shadow_booking_as_parent/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>source/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>document_template/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>csv_upload_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>omit_print/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>original_shipment/strong>span classtext-muted pl-2>/span>/div>p>An optional link to the original shipment, when creating a return-shipment/p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>order/strong>div classtext-muted>has_one/div>br>a href#orders>orders/a>.strong>shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.strong>printer_client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.strong>original_shipment/strong>div classtext-muted>has_one/div>br>a href#shipments>shipments/a>.strong>pickup/strong>div classtext-muted>has_one/div>br>a href#pickups>pickups/a>.strong>shadow_shipment/strong>div classtext-muted>has_one/div>br>a href#shipments>shipments/a>.strong>return/strong>div classtext-muted>has_one/div>br>a href#returns>returns/a>.strong>document_template/strong>div classtext-muted>has_one/div>br>a href#document_templates>document_templates/a>.strong>mail_template/strong>div classtext-muted>has_one/div>br>a href#mail_templates>mail_templates/a>.strong>return_label_mail_template/strong>div classtext-muted>has_one/div>br>a href#mail_templates>mail_templates/a>.strong>labels/strong>div classtext-muted>has_many/div>br>a href#labels>labels/a>.strong>documents/strong>div classtext-muted>has_many/div>br>a href#documents>documents/a>.strong>attachments/strong>div classtext-muted>has_many/div>br>a href#attachments>attachments/a>.strong>edis/strong>div classtext-muted>has_many/div>br>a href#edis>edis/a>.strong>additional_attributes/strong>div classtext-muted>has_many/div>br>a href#additional_attributes>additional_attributes/a>.strong>events/strong>div classtext-muted>has_many/div>br>a href#events>events/a>.strong>return_shipments/strong>div classtext-muted>has_many/div>br>a href#shipments>shipments/a>.strong>activities/strong>div classtext-muted>has_many/div>br>a href#activities>activities/a>.strong>status_events/strong>div classtext-muted>has_many/div>br>a href#activities>activities/a>.strong>stores/strong>div classtext-muted>has_many/div>br>a href#stores>stores/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>reference/code>, code>sorting_id/code>, code>created_at/code>, code>updated_at/code>, code>order/code>, code>carrier/code>, code>send_time/code>, code>status/code>, code>is_return/code>, code>printer_client/code>, code>delivery_country_code/code>, code>order_channel/code>, code>shipping_rate/code>, code>delivery_address/code>, code>sender_address/code>, code>without_shadow_shipments/code>, code>tracking_number/code>, code>free_text/code>, code>has_pickup/code>, code>activity_type/code>, code>order_lines/code>, code>billing_contact/code>, code>billing_email/code>, code>billing_company/code>, code>delivery_email/code>, code>delivery_contact/code>, code>delivery_company/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipments/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/shipments/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipments/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idshipments-pills-tab roletablist>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link active data-togglepill href#shipments_Full sample_samples idpills-shipments-Full sample-tab roletab>Full sample/a>/li>li classnav-item>a aria-controlspills-home aria-selectedtrue classnav-link  data-togglepill href#shipments_Use cases_samples idpills-shipments-Use cases-tab roletab>Use cases/a>/li>/ul>div classtab-content>div aria-labelledbypills-home-tab classtab-pane fade show active idshipments_Full sample_samples roletabpanel>div classtext-light>span classbadge badge-primary>GET/span>https://<account name>.api.webshipper.io/v2/shipments/432/div>p classtext-muted>Get shipment example/p>pre>code classjson>{  data: {    id: 432,    type: shipments,    links: {      self: /v2/shipments/432    },    attributes: {      reference: null,      comment: null,      service_code: null,      is_return: null,      packages:         {          id: 5634,          weight: 1000.0,          shipment_id: 432,          created_at: null,          updated_at: null,          weight_unit: g,          barcode_usage_id: null,          barcode_usage_type: null,          ext_ref: ref123,          labelless_code: null,          colli_type: null,          dangerous_goods_details: {          },          add_ons:           ,          customs_lines:             {              id: null,              package_id: 5634,              sku: SKU1,              description: Black pants,              quantity: 1,              tarif_number: 234343332,              country_of_origin: DE,              unit_price: 15.0,              vat_percent: 15.0,              currency: EUR,              created_at: null,              updated_at: null,              weight: 1000.0,              weight_unit: g,              discount: 0,              ext_ref: ref123,              dangerous_goods_details: {              }            }          ,          dimensions: {            id: null,            package_id: 5634,            height: 15.0,            width: 15.0,            length: 15.0,            created_at: null,            updated_at: null,            unit: cm,            load_meters: 0.009375,            volume: 3375.0          },          order_lines:             {              id: null,              sku: SKU1,              description: Black pants,              quantity: 1,              location: null,              tarif_number: 234343332,              country_of_origin: DE,              unit_price: 15.0,              vat_percent: 15.0,              order_id: null,              status: null,              ext_ref: null,              created_at: null,              updated_at: null,              package_id: 5634,              weight: 1000.0,              weight_unit: g,              discount_value: 0.0,              discount_type: fixed,              is_virtual: false,              dangerous_goods_details: {              },              discounted_unit_price: 15.0,              additional_attributes: {              }            }          ,          service_attributes:                   }      ,      delivery_address: {        id: null,        att_contact: null,        company_name: Webshipper ApS,        address_1: lyngbygade 8,        address_2: null,        zip: 8600,        city: Silkeborg,        country_code: DK,        state: null,        phone: null,        email: invoice@webshipper.com,        created_at: null,        updated_at: null,        address_type: recipient,        vat_no: null,        ext_location: null,        company_customs_numbers: {        },        formatted_recipient: Webshipper ApS,        voec: null,        eori: null,        sprn: null,        ioss: null,        fda: null,        duns: null,        personal_customs_no: null      },      sender_address: {        id: null,        att_contact: null,        company_name: Webshipper ApS,        address_1: lyngbygade 8,        address_2: null,        zip: 8600,        city: Silkeborg,        country_code: DK,        state: null,        phone: null,        email: invoice@webshipper.com,        created_at: null,        updated_at: null,        address_type: recipient,        vat_no: null,        ext_location: null,        company_customs_numbers: {        },        formatted_recipient: Webshipper ApS,        voec: null,        eori: null,        sprn: null,        ioss: null,        fda: null,        duns: null,        personal_customs_no: null      },      billing_address: null,      sold_from_address: null,      pickup_address: null,      return_address: null,      service_attributes:         {          id: null,          shipment_id: null,          attr_key: invoice_type,          attr_value: proforma,          created_at: null,          updated_at: null,          service_attributable_id: 432,          service_attributable_type: Shipment,          attr_type: string        },        {          id: null,          shipment_id: null,          attr_key: cod_amount,          attr_value: 532.2,          created_at: null,          updated_at: null,          service_attributable_id: 432,          service_attributable_type: Shipment,          attr_type: string        }      ,      add_ons:         COD      ,      sms_notification: null,      email_notification: null,      drop_point: null,      tracking_links:         {          id: 743,          url: https://tracking.example.com?number1234567,          number: 1234567,          latest_transit_event: information_received,          delivered: false,          package_id: 5634,          tracking_events:             {              status: information_received,              description: We have been notified about the package but have not yet picked it up yet,              time: null,              event_id: null,              location: null,              latitude: null,              longitude: null            }                  }      ,      fulfill_immediately: true,      test_mode: null,      dutiable: null,      created_at: null,      ext_ref: null,      original_shipment_id: null,      send_time: null,      status: booked,      latest_update_time: null,      supports_updates: false,      additional_attributes: {      },      cost_price: null,      sales_price: null,      currency: null,      manual_order_shipment_creation: false,      carrier_type_name: PostNord,      carrier_alias: PostNord domestic,      carrier_id: null,      invoice_settings: null,      latest_activity: null,      latest_status_event: null,      shadow_booking_as_parent: null,      source: api,      document_template: null,      csv_upload_id: null,      omit_print: false    },    relationships: {      carrier: {        links: {          self: /v2/shipments/432/relationships/carrier,          related: /v2/shipments/432/carrier        }      },      order: {        links: {          self: /v2/shipments/432/relationships/order,          related: /v2/shipments/432/order        }      },      shipping_rate: {        links: {          self: /v2/shipments/432/relationships/shipping_rate,          related: /v2/shipments/432/shipping_rate        }      },      printer_client: {        links: {          self: /v2/shipments/432/relationships/printer_client,          related: /v2/shipments/432/printer_client        }      },      original_shipment: {        links: {          self: /v2/shipments/432/relationships/original_shipment,          related: /v2/shipments/432/original_shipment        }      },      pickup: {        links: {          self: /v2/shipments/432/relationships/pickup,          related: /v2/shipments/432/pickup        }      },      shadow_shipment: {        links: {          self: /v2/shipments/432/relationships/shadow_shipment,          related: /v2/shipments/432/shadow_shipment        }      },      return: {        links: {          self: /v2/shipments/432/relationships/return,          related: /v2/shipments/432/return        }      },      document_template: {        links: {          self: /v2/shipments/432/relationships/document_template,          related: /v2/shipments/432/document_template        },        data: null      },      mail_template: {        links: {          self: /v2/shipments/432/relationships/mail_template,          related: /v2/shipments/432/mail_template        },        data: null      },      return_label_mail_template: {        links: {          self: /v2/shipments/432/relationships/return_label_mail_template,          related: /v2/shipments/432/return_label_mail_template        },        data: null      },      labels: {        links: {          self: /v2/shipments/432/relationships/labels,          related: /v2/shipments/432/labels        }      },      documents: {        links: {          self: /v2/shipments/432/relationships/documents,          related: /v2/shipments/432/documents        }      },      attachments: {        links: {          self: /v2/shipments/432/relationships/attachments,          related: /v2/shipments/432/attachments        }      },      edis: {        links: {          self: /v2/shipments/432/relationships/edis,          related: /v2/shipments/432/edis        }      },      additional_attributes: {        links: {          self: /v2/shipments/432/relationships/additional_attributes,          related: /v2/shipments/432/additional_attributes        }      },      events: {        links: {          self: /v2/shipments/432/relationships/events,          related: /v2/shipments/432/events        }      },      return_shipments: {        links: {          self: /v2/shipments/432/relationships/return_shipments,          related: /v2/shipments/432/return_shipments        }      },      activities: {        links: {          self: /v2/shipments/432/relationships/activities,          related: /v2/shipments/432/activities        }      },      status_events: {        links: {          self: /v2/shipments/432/relationships/status_events,          related: /v2/shipments/432/status_events        }      },      stores: {        links: {          self: /v2/shipments/432/relationships/stores,          related: /v2/shipments/432/stores        }      }    },    meta: {      copyright: © 2025 Webshipper ApS    }  }}/code>/pre>/div>div aria-labelledbypills-home-tab classtab-pane fade show  idshipments_Use cases_samples roletabpanel>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/shipments/div>p classtext-muted>Create shipment for an order, with overridden printer client - shipping rate fetched from the order/p>pre>code classjson>{
  data: {
    type: shipments,
    relationships: {
      order: {
        data: {
          type: orders,
          id: 2341
        }
      },
      printer_client: {
        data: {
          type: printer_clients,
          id: 12
        }
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/shipments/div>p classtext-muted>Partially send an order/p>pre>code classjson>{
  data: {
    type: shipments,
    attributes: {
      packages: 
        {
          ext_ref: ref123,
          weight: 100,
          weight_unit: g,
          dimensions: {
            unit: cm,
            height: 15,
            width: 15,
            length: 15
          },
          order_lines: 
            {
              id: 2
            },
            {
              id: 3
            }
          
        }
      
    },
    relationships: {
      order: {
        data: {
          type: orders,
          id: 2341
        }
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/shipments/div>p classtext-muted>Create a shipment with documents by attachemnt (attaching document with id 1) and direct upload/p>pre>code classjson>{
  data: {
    type: shipments,
    attributes: {
      included_documents: 
        {
          document_id: 1
        },
        {
          base64: ....,
          document_format: PDF,
          document_size: A4,
          document_type: invoice
        }
      
    },
    relationships: {
      order: {
        data: {
          type: orders,
          id: 123
        }
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/shipments/div>p classtext-muted>Create a shipment with service attributes and addons, the addon name, attribute key, type and potential dependencies are gotten from the addons and parameters fields in a service quote./p>pre>code classjson>{
  data: {
    type: shipments,
    attributes: {
      service_attributes: 
        {
          attr_key: invoice_type,
          attr_value: proforma
        },
        {
          attr_key: cod_amount,
          attr_value: 512.5
        }
      ,
      add_ons: 
        COD
      
    },
    relationships: {
      order: {
        data: {
          type: orders,
          id: 123
        }
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>POST/span>https://<account name>.api.webshipper.io/v2/shipments/div>p classtext-muted>Create shipment with a shipping rate/p>pre>code classjson>{
  data: {
    type: shipments,
    attributes: {
      sender_address: {
        company_name: Webshipper ApS,
        att_contact: Thomas,
        address_1: Lyngbygade 8,
        zip: 8600,
        city: Silkeborg
      },
      delivery_address: {
        company_name: Test company,
        att_contact: Peter hansen,
        address_1: Silkeborgvej 291,
        zip: 8230,
        city: Åbyhøj,
        country_code: DK
      },
      packages: 
        {
          ext_ref: ref123,
          weight: 100,
          weight_unit: g,
          dimensions: {
            unit: cm,
            height: 15,
            width: 15,
            length: 15
          }
        }
      
    },
    relationships: {
      shipping_rate: {
        data: {
          type: shipping_rates,
          id: 234
        }
      }
    }
  }
}/code>/pre>div classtext-light>span classbadge badge-primary>PUT/span>https://<account name>.api.webshipper.io/v2/shipments/div>p classtext-muted>Update shipment with new package and service attributes (Use shipment id as path parameter in endpoint, i.e. /shipments/id)/p>pre>code classjson>{
  data: {
    id: id,
    type: shipments,
    attributes: {
      packages: 
        {
          id: existing_package_id,
          ext_ref: ref123,
          weight: 500,
          weight_unit: g,
          dimensions: {
            unit: cm,
            height: 20,
            width: 30,
            length: 10
          },
          service_attributes: 
            {
              attr_key: colli_description,
              attr_value: This package exists before the update and should still exist
            }
          
        },
        {
          ext_ref: ref123,
          weight: 100,
          weight_unit: g,
          dimensions: {
            unit: cm,
            height: 15,
            width: 15,
            length: 15
          },
          service_attributes: 
            {
              attr_key: colli_description,
              attr_value: This package is added as a new package as it has no id attribute
            }
          
        }
      ,
      service_attributes: 
        {
          attr_key: prebooking_status,
          attr_value: Prebook
        }
      
    }
  }
}/code>/pre>/div>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idshipping_addresses stylemin-height: 700px;>h2>Shipping Address/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/shipping_addresses/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>att_contact/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Att person. To generate parcels either att_contact strong>or/strong> company_name is required/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>company_name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Company name. To generate parcels either att_contact strong>or/strong> company_name is required/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_1/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Address line 1/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_2/strong>span classtext-muted pl-2>string/span>/div>p>Address line 2/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>country_code/strong>span classtext-muted pl-2>requiredstring/span>/div>p>ISO 3166-1 alpha-2 code/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>state/strong>span classtext-muted pl-2>string/span>/div>p>Sub-division of country, if applicable. State code. ISO 3166-2 alpha-2/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>phone/strong>span classtext-muted pl-2>string/span>/div>p>Phone number of the entity. This can be used for SMS notifications./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email/strong>span classtext-muted pl-2>string/span>/div>p>E-mail address of the entity. This can be used for e-mail notifications./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>zip/strong>span classtext-muted pl-2>string/span>/div>p>Postal code of the entity. This is required for most destination countries./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>city/strong>span classtext-muted pl-2>string/span>/div>p>City of the entity. This is required for most destination countries./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>vat_no/strong>span classtext-muted pl-2>string/span>/div>p>The VAT number of the entity. This is only required for address_type code>sold_from/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_type/strong>span classtext-muted pl-2>string/span>/div>p>Used for special addresses for order channels. This will be one of the following: code>recipient/code>, code>sender/code>, code>sold_from/code>, code>pickup/code>, code>return/code>, code>order_address/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ext_location/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>voec/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>eori/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sprn/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ioss/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>fda/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>duns/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>personal_customs_no/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>company_customs_numbers/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>att_contact/code>, code>company_name/code>, code>address_1/code>, code>address_2/code>, code>country_code/code>, code>state/code>, code>zip/code>, code>address_type/code>, code>search/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipping_addresses/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipping_addresses/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/shipping_addresses/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/shipping_addresses/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/shipping_addresses/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idshipping_addresses-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idshipping_mappings stylemin-height: 700px;>h2>Shipping Mapping/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/shipping_mappings/div>div classmb-3>/div>p>A shipping mapping maps unknown shipping methods to one of the order channels known shipping rates after an order is created. In the Webshipper user interface, this feature is known as linking shipping rates./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>shipping_code/strong>span classtext-muted pl-2>string/span>/div>p>Shipping code is a unique identifier from the order channel that will be mapped to a shipping rate/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_name/strong>span classtext-muted pl-2>string/span>/div>p>Shipping name is a human readable identifier of the shipping method/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipping_rate_id/strong>span classtext-muted pl-2>integer/span>/div>p>Shipping rate id is the id of the shipping rate which you want to map to./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>integer/span>/div>p>Order channel id of the order channel/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>h5>Relationships/h5>strong>shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.strong>order_channel/strong>div classtext-muted>has_one/div>br>a href#order_channels>order_channels/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>order_channel_id/code>, code>order_channel/code>, code>shipping_code/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipping_mappings/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipping_mappings/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/shipping_mappings/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/shipping_mappings/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/shipping_mappings/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idshipping_mappings-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idshipping_rates stylemin-height: 700px;>h2>Shipping Rate/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/shipping_rates/div>div classmb-3>/div>p>In most e-commerce systems, a shipping rate is displayed as a selectable option.br>Shipping rates have many regions, and each of these regions has one or more expressions. Expressions are strings that are evaluated to see if the shipping rate matches the input, please see section em>1.2 Common use Cases, Quoting an Order Channel for Shipping Rates./em>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>carrier_id/strong>span classtext-muted pl-2>integer/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Id of the carrier which the shipping rate belongs to/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channel_id/strong>span classtext-muted pl-2>integer/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Id of the order channel which the shipping rate belongs to/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Name to be displayed in the e-commerce system./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carrier_service_code/strong>span classtext-muted pl-2>requiredstring/span>/div>p>The carriers service code which must be used when generating parcels with this shipping rate./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>require_drop_point/strong>span classtext-muted pl-2>boolean/span>/div>p>Determines if the shipping rate requires a drop point to be assigned./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>visible_for/strong>span classtext-muted pl-2>integer/span>/div>p>Enum - determines whether the rate is returned for all customers, private_customers or business customers. This must be one of the following values:  code>any/code>, code>privat_customers/code>, code>business_customers/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>service_attributes/strong>span classtext-muted pl-2>/span>/div>p>Array of flattened resources of type code>Service Attribute/code>. Depends on the carrier services requirements. Service Attribute has the following attributes:  code>attr_key/code>, code>attr_value/code>. You may use the Webshipper Template Language (WTL) for the values./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dimensions/strong>span classtext-muted pl-2>/span>/div>p>Predefined dimensions which are a assigned when using the shipping rate. Attributes are: code>height/code>,code>width/code> and code>length/code>. The Webshipper Template Language (WTL) may be used for the values./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>add_ons/strong>span classtext-muted pl-2>/span>/div>p>Array of add_ons supported by the carrier service./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_return/strong>span classtext-muted pl-2>boolean/span>/div>p>Defines whether the rate is a return (inbound) rate or a standard rate (outbound). Please be aware that this attribute must match the carriers service type./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carriers_email/strong>span classtext-muted pl-2>boolean/span>/div>p>When this is set to true, the shipping rate will enable e-mail notifications from the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>comment_map/strong>span classtext-muted pl-2>string/span>/div>p>Defines what content is included in the comment field. The Webshipper Template Language (WTL) may be used in this field. For example:  {{order.external_comment}}/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>reference_map/strong>span classtext-muted pl-2>string/span>/div>p>Defines what content is included in the reference field. The Webshipper Template Language (WTL) may be used in this field. For example: {{order.visible_ref}}/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carriers_sms/strong>span classtext-muted pl-2>boolean/span>/div>p>When this is set to true, the shipping rate will enable SMS notifications from the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>dutiable/strong>span classtext-muted pl-2>boolean/span>/div>p>Defines whether the goods sent using this shipping rate are dutiable./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_hidden/strong>span classtext-muted pl-2>boolean/span>/div>p>Attribute to indicate if the shipping rate is visible to order channels/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>click_collect/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>reference/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>default_colli_type/strong>span classtext-muted pl-2>string/span>/div>p>Predefined colli type to be used when using the shipping rate. Must be supported by the carrier./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sender_address_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>return_address_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>invoice_settings/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shadow_booking_keep_labels/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shadow_booking_keep_documents/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>ignore_rate_quote_validation/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>custom_message/strong>span classtext-muted pl-2>string/span>/div>p>Custom message to be displayed for the shipping rate/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>regions/strong>span classtext-muted pl-2>/span>/div>p>Flattended array of Regions. See section on Shipping Regions and Expressions for more details/p>hr>/div>h5>Relationships/h5>strong>*carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.The carrier which must be usedstrong>*order_channel/strong>div classtext-muted>has_one/div>br>a href#order_channels>order_channels/a>.The order channel which the shipping rate belongs to.strong>return_shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.strong>sender_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>return_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>mail_template/strong>div classtext-muted>has_one/div>br>a href#mail_templates>mail_templates/a>.strong>return_mail_template/strong>div classtext-muted>has_one/div>br>a href#mail_templates>mail_templates/a>.strong>document_template/strong>div classtext-muted>has_one/div>br>a href#document_templates>document_templates/a>.strong>shadow_booking_shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.strong>regions/strong>div classtext-muted>has_many/div>br>a href#regions>regions/a>.strong>stores/strong>div classtext-muted>has_many/div>br>a href#stores>stores/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>order_channel_id/code>, code>is_return/code>, code>is_hidden/code>, code>service_code/code>, code>shadow_bookings/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipping_rates/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/shipping_rates/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/shipping_rates/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/shipping_rates/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/shipping_rates/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idshipping_rates-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idexpressions stylemin-height: 700px;>h2>Shipping Rate Expression/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/expressions/div>div classmb-3>/div>p>Shipping rate expressions wraps expressions from the Webshipper Expression Language (WEL) with price details. When the WEL evaluates to true, the shipping rate will be returned in a rate quote. Please see section 8 for details regarding expressions./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>expression/strong>span classtext-muted pl-2>text/span>/div>p>Is the actual WEL expression to be evaluated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>vat_percent/strong>span classtext-muted pl-2>requiredfloat/span>/div>p>VAT rate in percentage which must be added to the price./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>currency/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Currency of the price/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>price/strong>span classtext-muted pl-2>requiredfloat/span>/div>p>The cost price displayed to the end user/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/expressions/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/expressions/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/expressions/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/expressions/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/expressions/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idexpressions-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idregions stylemin-height: 700px;>h2>Shipping Region/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/regions/div>div classmb-3>/div>p>Shipping regions handle multiple countries as a group, e.g. the European Union./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>Name/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>expressions/strong>span classtext-muted pl-2>/span>/div>p>Flattened array of expressions. Please see section 8 for more details regarding expressions./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>countries/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>shipping_rate/strong>div classtext-muted>has_one/div>br>a href#shipping_rates>shipping_rates/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/regions/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/regions/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/regions/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/regions/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/regions/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idregions-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idslip_templates stylemin-height: 700px;>h2>Slip Template/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/slip_templates/div>div classmb-3>/div>p>Templates for generating parcel slips. The Webshipper Template Language (WTL) may be used when creating templates./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>requiredstring/span>/div>p>Name to identify the template./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>slip_size/strong>span classtext-muted pl-2>integer/span>/div>p>Size of the parcel slip. Possible values: code>A4/code> and code>4X6/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>additional_content/strong>span classtext-muted pl-2>text/span>/div>p>Content after the table of order lines for A4-based parcel slips./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>additional_content_align/strong>span classtext-muted pl-2>integer/span>/div>p>Alignment of additional_content. Possible values: code>center/code>, code>right/code>, code>left/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>barcode_content/strong>span classtext-muted pl-2>string/span>/div>p>Content of the barcode/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>header_content/strong>span classtext-muted pl-2>text/span>/div>p>Content of the slip header/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>top_left_content_header/strong>span classtext-muted pl-2>string/span>/div>p>Header of the top left corner/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>top_right_content_header/strong>span classtext-muted pl-2>string/span>/div>p>Header of the top right corner/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>top_left_content/strong>span classtext-muted pl-2>text/span>/div>p>Content of the top left corner/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>top_right_content/strong>span classtext-muted pl-2>text/span>/div>p>Content of the top right corner/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>footer_content/strong>span classtext-muted pl-2>text/span>/div>p>Content of the footer/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>slip_template_columns/strong>span classtext-muted pl-2>/span>/div>p>Array of columns. Column objects contains: code>name/code>code>content/code>, code>text_alignment/code>(right, left, center), code>width/code> (in percentage)/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>table_color/strong>span classtext-muted pl-2>string/span>/div>p>HEX color including #/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>table_text_color/strong>span classtext-muted pl-2>string/span>/div>p>HEX color including #/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>sort_key/strong>span classtext-muted pl-2>string/span>/div>p>The key to sort the order-lines by/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>returns_only/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>disable_inline_formatting/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>used_by_order_channels/strong>span classtext-muted pl-2>/span>/div>p>which order_channels use slip_template. If not used by any, it will return empty list/p>hr>/div>h5>Relationships/h5>strong>order_channels/strong>div classtext-muted>has_many/div>br>a href#order_channels>order_channels/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>returns_only/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/slip_templates/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/slip_templates/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/slip_templates/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/slip_templates/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/slip_templates/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idslip_templates-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idslip_template_previews stylemin-height: 700px;>h2>Slip Template Preview/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/slip_template_previews/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>slip_template/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_visible_ref/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>base64/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>example_id/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/slip_template_previews/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/slip_template_previews/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/slip_template_previews/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/slip_template_previews/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/slip_template_previews/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idslip_template_previews-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idstores stylemin-height: 700px;>h2>Store/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/stores/div>div classmb-3>/div>p>Used for click n collect if activated on the shipping rate./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_1/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>address_2/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>zip/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>city/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>state/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>country_code/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>longitude/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latitude/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>sender_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>return_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>pickup_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>sold_from_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>shipping_rates/strong>div classtext-muted>has_many/div>br>a href#shipping_rates>shipping_rates/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/stores/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/stores/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/stores/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/stores/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/stores/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idstores-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idtags stylemin-height: 700px;>h2>Tag/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/tags/div>div classmb-3>/div>p>Read only resources describing all tags used. The index action returns a unique list of all tags currently/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>tag/strong>span classtext-muted pl-2>string/span>/div>p>div classbadge badge-warning mr-3>Read only/div>/p>hr>/div>h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/tags/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idtags-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idtracking_events stylemin-height: 700px;>h2>Tracking Event/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/tracking_events/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>string/span>/div>p>One of em>information_received/em>, em>in_transit/em>, em>out_for_delivery/em>, em>customs_clearance_delayed/em>, em>attempted_delivery/em>, em>ready_for_pickup/em>, em>delivered_to_drop_point/em>, em>delivered/em>, em>returned/em>, em>undeliverable/em> or em>unknown/em>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>time/strong>span classtext-muted pl-2>datetime/span>/div>p>Time the event occured at the carrier/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>description/strong>span classtext-muted pl-2>text/span>/div>p>Readable description of the event/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>location/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latitude/strong>span classtext-muted pl-2>float/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>longitude/strong>span classtext-muted pl-2>float/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tracking_number/strong>span classtext-muted pl-2>/span>/div>p>The tracking number for this event, if availiable/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>event_id/strong>span classtext-muted pl-2>string/span>/div>p>Unique event of the id/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_id/strong>span classtext-muted pl-2>integer/span>/div>p>ID of shipment/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tracking_link_id/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>tracking_link_url/strong>span classtext-muted pl-2>/span>/div>p>The tracking link for this event, if availiable/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>package/strong>div classtext-muted>has_one/div>br>a href#packages>packages/a>.The package for this event, if availiablestrong>shipment/strong>div classtext-muted>has_one/div>br>a href#shipments>shipments/a>.The shipment for this event.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>created_at/code>, code>shipment_id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/tracking_events/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/tracking_events/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idtracking_events-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idtriggers stylemin-height: 700px;>h2>Trigger/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/triggers/div>div classmb-3>/div>p>Trigger for automations. When evaluated to true, the automation will start./p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>expression/strong>span classtext-muted pl-2>text/span>/div>p>WEL expression for the trigger/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>expression_ast/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>model_type/strong>span classtext-muted pl-2>string/span>/div>p>Model for the trigger. E.g. Order/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>event/strong>span classtext-muted pl-2>string/span>/div>p>code>created/code> or code>updated/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>timing/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>automation/strong>div classtext-muted>has_one/div>br>a href#automations>automations/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/triggers/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/triggers/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/triggers/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/triggers/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/triggers/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idtriggers-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idusers stylemin-height: 700px;>h2>User/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/users/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>first_name/strong>span classtext-muted pl-2>string/span>/div>p>The users first name./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>last_name/strong>span classtext-muted pl-2>string/span>/div>p>The users last name./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>email/strong>span classtext-muted pl-2>string/span>/div>p>The users e-mail address./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>password/strong>span classtext-muted pl-2>integer/span>/div>p>The users password. This can only be used for changing the password./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>last_sign_in_at/strong>span classtext-muted pl-2>datetime/span>/div>p>The time of the most recent sign-in by the user./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>all_order_channels/strong>span classtext-muted pl-2>boolean/span>/div>p>Specifies whether the user has access to all order channels on the tenant./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>all_carriers/strong>span classtext-muted pl-2>boolean/span>/div>p>Specifies whether the user has access to all of the carriers for tenant./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>hidden/strong>span classtext-muted pl-2>boolean/span>/div>p>Specifies whether the user should be hidden in the user interface./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>current_password/strong>span classtext-muted pl-2>/span>/div>p>This must be set when changing the password of the user./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>locale/strong>span classtext-muted pl-2>integer/span>/div>p>Locale enum. code>da/code> or code>en/code>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>locked_until/strong>span classtext-muted pl-2>datetime/span>/div>p>Locked until specified datetime/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>failed_count/strong>span classtext-muted pl-2>integer/span>/div>p>Amount of failed login attempts since last login/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>is_locked/strong>span classtext-muted pl-2>/span>/div>p>Read only. Will be true when the user is temporarily locked due to too many login attempts/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>user_status/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>home_page/strong>span classtext-muted pl-2>text/span>/div>p>The home page set by the user/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>limit_order_search/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>view_ids/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>h5>Relationships/h5>strong>user_group/strong>div classtext-muted>has_one/div>br>a href#user_groups>user_groups/a>.strong>printer_client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.The printer client (workstation) which the user is currently assigned to.strong>order_channel_accesses/strong>div classtext-muted>has_many/div>br>a href#order_channel_accesses>order_channel_accesses/a>.strong>carrier_accesses/strong>div classtext-muted>has_many/div>br>a href#carrier_accesses>carrier_accesses/a>.strong>store_assignments/strong>div classtext-muted>has_many/div>br>a href#store_assignments>store_assignments/a>.strong>stores/strong>div classtext-muted>has_many/div>br>a href#stores>stores/a>.strong>favourite_pages/strong>div classtext-muted>has_many/div>br>a href#favourite_pages>favourite_pages/a>.strong>consents/strong>div classtext-muted>has_many/div>br>a href#user_consents>user_consents/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/users/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/users/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/users/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/users/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/users/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idusers-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column iduser_groups stylemin-height: 700px;>h2>User Group/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/user_groups/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>name/strong>span classtext-muted pl-2>string/span>/div>p>Name of the user group/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>scopes/strong>span classtext-muted pl-2>array/span>/div>p>Array of scopes. Please see section 6 for more details regarding scopes./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>locked/strong>span classtext-muted pl-2>boolean/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>h5>Relationships/h5>strong>users/strong>div classtext-muted>has_many/div>br>a href#users>users/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/user_groups/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/user_groups/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/user_groups/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/user_groups/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/user_groups/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 iduser_groups-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idwaybills stylemin-height: 700px;>h2>Waybill/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/waybills/div>div classmb-3>/div>p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>waybill_name/strong>span classtext-muted pl-2>string/span>/div>p>Name of the waybill type/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>waybill_code/strong>span classtext-muted pl-2>string/span>/div>p>Code identifying the type of waybill/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>reference/strong>span classtext-muted pl-2>string/span>/div>p>Unique reference returned from the carrier implementation when a waybill is opened./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>consolidation_key/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>barcode_serial/strong>span classtext-muted pl-2>integer/span>/div>p>This will be assigned by the API if the waybill type has a barcode requirement./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>status/strong>span classtext-muted pl-2>integer/span>/div>p>Indicates whether the waybill is open or closed. When you want to close the waybill, you simply need to update the status of the way bill and set it to closed./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>shipment_count/strong>span classtext-muted pl-2>/span>/div>p>This is a read-only attribute which returns the total number of shipments./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>currency/strong>span classtext-muted pl-2>string/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>copies/strong>span classtext-muted pl-2>integer/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>documents/strong>span classtext-muted pl-2>/span>/div>p>Array of documents. This is available when the waybill is closed./p>hr>/div>h5>Relationships/h5>strong>carrier/strong>div classtext-muted>has_one/div>br>a href#carriers>carriers/a>.strong>sold_to_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>sender_address/strong>div classtext-muted>has_one/div>br>a href#shipping_addresses>shipping_addresses/a>.strong>document_template/strong>div classtext-muted>has_one/div>br>a href#document_templates>document_templates/a>.strong>printer_client/strong>div classtext-muted>has_one/div>br>a href#printer_clients>printer_clients/a>.strong>shipments/strong>div classtext-muted>has_many/div>br>a href#shipments>shipments/a>.strong>documents/strong>div classtext-muted>has_many/div>br>a href#documents>documents/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>, code>status/code>, code>carrier/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/waybills/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/waybills/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/waybills/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/waybills/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/waybills/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idwaybills-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idwebhooks stylemin-height: 700px;>h2>Webhook/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/webhooks/div>div classmb-3>/div>p>p>Webhooks allow you to receive events from the Webshipper platform when resources are created, updated and changed.      Endpoints b>must reply with a status code 200 for successful requests/b> within the timeout of 7 seconds. Any validation error on you side must not result in the error response.      Other statuses (including redirects) are treated as errors. /p>      p> Webhook payloads are formatted as JSONAPI resources similar to other resources in the API.          Webhook payloads for tracking events have the related shipment and order sideloaded under included.          Webhook payloads for shipments have the related order sideloaded under included./p>      div classcard mb-2>div classcard-body bg-warning text-white>Webshipper highly recommends not processing webhooks immediately but instead putting the webhooks in a queue and then process the webhooks asynchronously./div>/div>      p>      Webhooks are retried 21 times over a period of 8 days. An e-mail message will be sent to your accounts technical contact if a webhook has been failing for 4 hours. After all retries have been exhaused, the webhook is disabled entirely and a new one must be created. The accounts technical contact will also be notified by e-mail when a webhook is disabled in this scenario./p>p>      All webhooks are sent using the X-Webshipper-Hmac-SHA256 header, which contains the Base64 encoding of the HMAC of the JSON request body signed with your customer secret using SHA256. Webhooks also include the X-Webshipper-Topic header used to indicate the webhook topic.      /p>      p>      Example in Ruby: pre>code classruby>  Base64.strict_encode64(OpenSSL::HMAC.digest(sha256, secret, data)) /code> /pre>      Example in .NET pre>code classc-sharp>  var request_body  RAW REQUEST BODY GOES HERE: IT IS UTF8 ENCODED ✅;  var hmac  new HMACSHA256( Encoding.UTF8.GetBytes(secret123));  var digest  System.Convert.ToBase64String(hmac.ComputeHash(Encoding.UTF8.GetBytes(request_body)));  Console.WriteLine(digest);          /code>        /pre>      /p>      p>Note that for deleted webhooks, not all attributes can be expected to be present/p>      /p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>url/strong>span classtext-muted pl-2>string/span>/div>p>The HTTP endpoint to be called. Webhooks always use POST as the request method./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>topic/strong>span classtext-muted pl-2>string/span>/div>p>Which event should trigger the webhooks. Supported topics:    ul>      li>strong>order/created/strong> triggered when an order is created./li>      li>strong>order/updated/strong> triggered when an order is updated./li>      li>strong>order/deleted/strong> triggered when an order was deleted./li>      li>strong>shipment/created/strong> triggered when a shipment is created./li>      li>strong>shipment/updated/strong> triggered when a shipment is updated./li>      li>strong>shipment/deleted/strong> triggered when a shipment was deleted./li>      li>strong>return/created/strong> triggered when a return is created./li>      li>strong>return/updated/strong> triggered when a return is updated./li>      li>strong>return/deleted/strong> triggered when a return was deleted./li>      li>strong>report/created/strong> triggered when a report is created./li>      li>strong>report/updated/strong> triggered when a report is updated./li>      li>strong>report/deleted/strong> triggered when a report was deleted./li>      li>strong>trackingevent/created/strong> triggered when a tracking event is created./li>      li>strong>trackingevent/updated/strong> triggered when a tracking event is updated./li>      li>strong>trackingevent/deleted/strong> triggered when a tracking event was deleted./li>    /ul>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>enabled/strong>span classtext-muted pl-2>boolean/span>/div>p>This is a boolean attribute that specifies whether the webhook is active./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>secret/strong>span classtext-muted pl-2>string/span>/div>p>The secret used to sign the HMAC./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>health/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>latest_error/strong>span classtext-muted pl-2>text/span>/div>p>The most recent error message./p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>condition/strong>span classtext-muted pl-2>text/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>carriers/strong>span classtext-muted pl-2>/span>/div>p>/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>order_channels/strong>span classtext-muted pl-2>array/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Array of objects containing keys id and channel_label if condition describes a list of allowed order channels, code>null/code> otherwise. /p>hr>/div>h5>Relationships/h5>strong>owner/strong>div classtext-muted>has_one/div>br>Polymorphic.The User or the Application that created the webhookstrong>failures/strong>div classtext-muted>has_many/div>br>a href#webhook_failures>webhook_failures/a>.strong>jobs/strong>div classtext-muted>has_many/div>br>a href#webhook_jobs>webhook_jobs/a>.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/webhooks/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/webhooks/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/webhooks/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/webhooks/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/webhooks/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idwebhooks-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>div classrow>div classcol-md-6 px-5 bg-white pb-5 pt-5>div classd-flex flex-column idwebhook_failures stylemin-height: 700px;>h2>Webhook Failure/h2>div classd-flex flex-column>div classtext-muted>https://<account name>.api.webshipper.io/v2/webhook_failures/div>div classmb-3>/div>p>p>A log entry with details of a failed webhook request the last 7 days./p>/p>h5>Attributes/h5>div classpl-2 pr-2>div classpb-2>strong>record_id/strong>span classtext-muted pl-2>integer/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The id of the record the webhook failed to send/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>message/strong>span classtext-muted pl-2>text/span>/div>p>div classbadge badge-warning mr-3>Read only/div>Title of the failure/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>created_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when the resource was created/p>hr>/div>div classpl-2 pr-2>div classpb-2>strong>updated_at/strong>span classtext-muted pl-2>datetime/span>/div>p>div classbadge badge-warning mr-3>Read only/div>The time when resource was last updated or when it was created if it was never updated/p>hr>/div>h5>Relationships/h5>strong>webhook/strong>div classtext-muted>has_one/div>br>a href#webhooks>webhooks/a>.The Webhook this failures belongs to.h5 classmt-5>Filters/h5>p classmb-5>code>id/code>/p>/div>div classmb-5 stylemargin-top: auto>h5>Routes/h5>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/webhook_failures/{id}/div>div>div classbadge badge-primary>GET/div>https://<account name>.api.webshipper.io/v2/webhook_failures/div>div>div classbadge badge-secondary>PATCH/div>https://<account name>.api.webshipper.io/v2/webhook_failures/{id}/div>div>div classbadge badge-success>POST/div>https://<account name>.api.webshipper.io/v2/webhook_failures/div>div>div classbadge badge-danger>DELETE/div>https://<account name>.api.webshipper.io/v2/webhook_failures/{id}/div>/div>/div>/div>div classcol-md-6 px-4>ul classsamples nav nav-pills active mb-3 mt-5 idwebhook_failures-pills-tab roletablist>/ul>div classtab-content>/div>/div>/div>/div>/div>/div>/body>/html>

Subdomains

Date	Domain	IP
styled.api.webshipper.io	2025-10-28	34.240.151.197
skall-studio-aps.api.webshipper.io	2026-03-01	52.209.148.215

View on OTX | View on ThreatMiner

Data with thanks to AlienVault OTX, VirusTotal, Malwr and others. [Sitemap]

Domain > skall-studio-aps.api.webshipper.io

Is this malicious?

DNS Resolutions

Port 80

Port 443

Subdomains