--- title: "POST /salesOrder/id/{id}/createShipment" method: POST path: "/salesOrder/id/{id}/createShipment" tags: ["salesOrder"] --- # POST /salesOrder/id/{id}/createShipment `POST /salesOrder/id/{id}/createShipment` ## Request - Base URL: `https://www.weclapp.com/api/nullapi/v2` - URL: `https://www.weclapp.com/api/nullapi/v2/salesOrder/id/{id}/createShipment` - Auth: API key in header `AuthenticationToken` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `id` string, required ## Request body - object - `additionalSalesOrderIds` string[] - `customAttributes` CustomAttribute[] - `attributeDefinitionId` string - `booleanValue` boolean - `dateValue` integer - `entityId` string - `entityReferences` EntityReference[] - `entityId` string - `entityName` string - `numberValue` string, number - `selectedValueId` string - `selectedValues` OnlyId[] - `id` string - `stringValue` string ## Response `200` createShipment response - object - `result` Shipment - `id` string - `version` string - `additionalDeliveryInformation` string - `commercialLanguage` string - `consolidationStoragePlaceId` string - `createdDate` integer - `creatorId` string - `customAttributes` CustomAttribute[] - `attributeDefinitionId` string - `booleanValue` boolean - `dateValue` integer - `entityId` string - `entityReferences` EntityReference[] - `entityId` string - `entityName` string - `numberValue` string, number - `selectedValueId` string - `selectedValues` OnlyId[] - `id` string - `stringValue` string - `customerPurchaseOrderNumber` string - `declaredValueAmount` string, number - `declaredValueAmountCurrencyId` string - `deliveryDate` integer - `description` string - `destinationStoragePlaceId` string - `destinationWarehouseId` string - `dhlReceiverId` string - `disableRecordEmailingRule` boolean - `invoiceAddress` RecordAddress - `city` string - `company` string - `company2` string - `countryCode` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UNKNOWN' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' - `firstName` string - `globalLocationNumber` string - `lastName` string - `middleName` string - `phoneNumber` string - `postOfficeBoxCity` string - `postOfficeBoxNumber` string - `postOfficeBoxZipCode` string - `salutation` 'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION' - `state` string - `street1` string - `street2` string - `titleId` string - `zipcode` string - `invoiceRecipientId` string - `lastModifiedDate` integer - `lastStatusChangeUserId` string - `mainSalesOrderId` string - `packageHeight` integer - `packageLength` integer - `packageReferenceNumber` string - `packageReturnTrackingNumber` string - `packageReturnTrackingUrl` string - `packageTrackingNumber` string - `packageTrackingUrl` string - `packageWeight` string, number - `packageWidth` integer - `parcels` Parcel[] - `id` string - `version` string - `cashOnDeliveryBankAccountId` string - `cashOnDeliveryCurrencyId` string - `createdDate` integer - `customAttributes` CustomAttribute[] - `attributeDefinitionId` string - `booleanValue` boolean - `dateValue` integer - `entityId` string - `entityReferences` EntityReference[] - `entityId` string - `entityName` string - `numberValue` string, number - `selectedValueId` string - `selectedValues` OnlyId[] - `id` string - `stringValue` string - `declaredValueAmount` string, number - `declaredValueCurrencyId` string - `dhlGoGreenPlusService` boolean - `dhlPostalDeliveredDutyPaidService` boolean - `dhlPremiumInternationalService` boolean - `height` integer - `lastModifiedDate` integer - `length` integer - `packagingWeight` string, number - `positionNumber` integer, required - `reference` string - `saturdayDelivery` boolean - `shippingCarrierAddition` string - `shippingCarrierId` string - `shippingLabelsCount` integer - `trackingId` string - `trackingUrl` string - `useDeliveryDateAsPreferredDeliveryDate` boolean - `weight` string, number - `width` integer - `pickingInstructions` string - `picksComplete` boolean - `purchaseOrders` OnlyId[] - `id` string - `recipientAddress` RecordAddress - `city` string - `company` string - `company2` string - `countryCode` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UNKNOWN' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' - `firstName` string - `globalLocationNumber` string - `lastName` string - `middleName` string - `phoneNumber` string - `postOfficeBoxCity` string - `postOfficeBoxNumber` string - `postOfficeBoxZipCode` string - `salutation` 'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION' - `state` string - `street1` string - `street2` string - `titleId` string - `zipcode` string - `recipientCustomerNumber` string - `recipientPartyId` string - `recipientSupplierNumber` string - `recordComment` string - `recordEmailAddresses` EmailAddresses - `bccAddresses` string - `ccAddresses` string - `toAddresses` string - `recordFreeText` string - `recordOpening` string - `responsibleUserId` string - `salesInvoiceEmailAddresses` EmailAddresses - `bccAddresses` string - `ccAddresses` string - `toAddresses` string - `salesOrders` OnlyId[] - `id` string - `sentToRecipient` boolean - `shipmentItems` ShipmentItem[] - `id` string - `version` string - `addPageBreakBefore` boolean - `articleId` string - `createdDate` integer - `customAttributes` CustomAttribute[] - `attributeDefinitionId` string - `booleanValue` boolean - `dateValue` integer - `entityId` string - `entityReferences` EntityReference[] - `entityId` string - `entityName` string - `numberValue` string, number - `selectedValueId` string - `selectedValues` OnlyId[] - `id` string - `stringValue` string - `description` string - `descriptionFixed` boolean - `groupName` string - `itemType` 'DEFAULT' | 'FREE_TEXT' | 'SAMPLE' | 'SERVICE' | 'SERVICE_QUOTA' - `lastModifiedDate` integer - `manualQuantity` boolean - `note` string - `parentItemId` string - `picks` ItemPick[] - `id` string - `version` string - `batchNumber` string - `bookedDate` integer - `confirmedByUserId` string - `confirmedDate` integer - `createdDate` integer - `customAttributes` CustomAttribute[] - `attributeDefinitionId` string - `booleanValue` boolean - `dateValue` integer - `entityId` string - `entityReferences` EntityReference[] - `entityId` string - `entityName` string - `numberValue` string, number - `selectedValueId` string - `selectedValues` OnlyId[] - `id` string - `stringValue` string - `internalTransportReferenceId` string - `lastModifiedDate` integer - `orderItemId` string - `quantity` string, number, required - `serialNumbers` string[], required - `sourceInternalTransportReferenceId` string - `sourceStoragePlaceId` string - `storagePlaceId` string, required - `transportationOrderId` string - `positionNumber` integer - `purchaseOrderItemId` string - `quantity` string, number - `returnAssessmentId` string - `returnAssessments` OnlyId[] - `id` string - `returnDescription` string - `returnErrorId` string - `returnErrors` OnlyId[] - `id` string - `returnReasonId` string - `returnReasons` OnlyId[] - `id` string - `returnRectificationId` string - `returnRectifications` OnlyId[] - `id` string - `salesOrderItemId` string - `title` string - `unitId` string - `shipmentMethodId` string - `shipmentNumber` string - `shipmentType` 'CONSIGNMENT' | 'CONSIGNMENT_RETURN' | 'CUSTOMER_COMPENSATION' | 'INTERNAL' | 'STANDARD' | 'SUPPLIER_RETURN' - `shippedFromAddress` RecordAddress - `city` string - `company` string - `company2` string - `countryCode` 'AC' | 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CS' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DG' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EA' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'EU' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'IC' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TA' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'UNKNOWN' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XI' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' - `firstName` string - `globalLocationNumber` string - `lastName` string - `middleName` string - `phoneNumber` string - `postOfficeBoxCity` string - `postOfficeBoxNumber` string - `postOfficeBoxZipCode` string - `salutation` 'COMPANY' | 'FAMILY' | 'MR' | 'MRS' | 'NO_SALUTATION' - `state` string - `street1` string - `street2` string - `titleId` string - `zipcode` string - `shippingCarrierId` string - `shippingDate` integer - `shippingLabelsCount` integer - `shippingReturnCarrierId` string - `shippingReturnLabelsCount` integer - `status` 'CANCELLED' | 'DELIVERED' | 'DELIVERY_NOTE_PRINTED' | 'INCOMING_CANCELLED' | 'INCOMING_MOVED_INTO_STORE' | 'INCOMING_SHIPPED' | 'IN_ROUTE' | 'NEW' | 'SHIPPED', required - `statusHistory` ShipmentStatus[] - `status` 'CANCELLED' | 'DELIVERED' | 'DELIVERY_NOTE_PRINTED' | 'INCOMING_CANCELLED' | 'INCOMING_MOVED_INTO_STORE' | 'INCOMING_SHIPPED' | 'IN_ROUTE' | 'NEW' | 'SHIPPED' - `statusDate` integer - `userId` string - `tags` string[] - `totalWeight` string, number - `warehouseId` string ## Other responses - `default`: error response --- [API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)