Création de commande
Présentation
L'API de commande vous permet de créer et d'envoyer des commandes directement à Waldom. Cette API est conçue pour s'intégrer de manière transparente à votre ERP ou à votre site web existant, facilitant ainsi le traitement efficace des commandes.
Important : avant de créer une commande, vous devez avoir enregistré un profil de paiement dans votre compte d'entreprise. Cela garantit que toutes les informations nécessaires au traitement de la commande sont déjà en place.
Caractères acceptés : notre API n'accepte que les entrées contenant des caractères anglais standard, à savoir les lettres A à Z en majuscules et en minuscules. Les entrées ne doivent contenir aucun signe diacritique ni caractère spécial,
Paramètres de requête
| Parameter | Description | Required |
|---|---|---|
| buyer email | The email address of the customer to be associated to the sales order | yes |
purchase order number | The customer order unique alphanumeric identifier. | yes |
on hold | On hold orders will not be processed untill they are released, allowed values: true,false. Blank is equivalent to false. | |
| shipping method | Check available shipping methods for possible values. If your account is setup with a default shipping method and this field is blank; the default shipping method will be selected. Shipping methods availability depends on the order shipping country. | yes |
shipping account No | Blank if not shipping with freight account number | |
other shipping carrier | Blank if shipping with listed carriers | |
invoice CC email | ||
invoice CC email 2 | ||
notify when shipped | To receive email notification when order is shipped | |
ADM use | Is any product specifically earmarked for Aerospace, Defense, or Marine (ADM) end use | |
backorder option | 1=order complete 2=line complete 3=split leav 0 for default | |
| shippingAddress | The shipping address for the order | yes |
| shippingAddress.company | The company name to be used for the ship-to address | yes |
| shippingAddress.countryTwoletterISOCode | The two character country code to be used for the ship-to address (e.g. US) | yes |
| shippingAddress.stateProvinceAbbreviation | The state or province to be used for the ultimate destination address | yes |
| shippingAddress.city | The city to be used for the ship-to address | yes |
| shippingAddress.address1 | The first address to be used for the ship-to address | yes |
| shippingAddress.address2 | The second address to be used for the ship-to address | |
| shippingAddress.zipPostalCode | The postal code to be used for the ship-to address | yes |
| shippingAddress.attention | The Attention to be used for the ship-to address | |
| paymentMethod | The payment method to pay for the order. Login to see payment methods possible values. | yes |
| order comment | Comment of the currently selected order | |
shipping comments | Shipping comments | |
EndCustomerNumber | End customer number | yes* |
EndCustomerOrderNumber | End customer order number | yes* |
EndCustomerPoNumber | End customer purchase order number | yes* |
EndCustomerCurrency | End customer currency | yes* |
| orderItem | yes | |
| orderItem.productId | The unique identifier for the order line item | yes |
| orderItem.lineNumber | The line number of the item | yes |
| orderItem.partNumber | ||
| orderItem.manufacturerName | ||
| orderItem.price | The product unit price | |
| orderItem.cutomerPartNumber | The customer custom part number | |
| orderItem.endCustomerCost | The cost of item for end customer | yes* |
orderItem.orderItemSchedules | ||
orderItem.orderItemSchedules.scheduleQuantity | The number of items purchased | yes |
orderItem.orderItemSchedules.requestedShipDate | Requested date to ship | yes |
orderItem.orderItemSchedules.requestedDeliveryDate | Requested date to deliver | yes |
orderItem.orderItemSchedules.scheduleLineNumber | sequence number |
*Only required if order is a blind fulfilment order
Méthodes d'expédition disponibles
| Service Code | |
|---|---|
| Add to Invoice | UPS STANDARD, UPS Trade Direct Standard, UPS Trade Direct Express |
| Freight Account | Cargo Compass, DB SCHENKER, DHL Economy, DHL Express 12.00, DHL Express 9.00, DHL Express Worldwide, DHL Standard, FedEx Express, FEDEX INT'L ECONOMY, FEDEX INT'L PRIORITY, FREIGHT, GEODIS WILSON, GLS, Panalpina, TNT Economy, TNT ECONOMY EXPRESS, TNT Express 12.00, TNT Express 9.00, UPS Air Freight Consolidated, UPS Air Freight Direct, UPS Expedited, UPS EXPRESS, UPS GROUND, UPS STANDARD, UPS Worldwide EXPRESS FREIGHT, UPS WORLDWIDE EXPRESS SAVER, UPS Trade Direct Standard, UPS Trade Direct ExpressWill Call/Pickup, Ziegler, Other |
Messages d'erreur potentiels
Vous trouverez ci-dessous une liste des messages d'erreur qui peuvent s'afficher en cas d'erreur dans la requête API ou si l'une des conditions préalables internes de Waldom n'est pas remplie.
| Description |
|---|
| Invalid buyer email |
| Billing address missing in account |
| Shipping address is required |
| Invalid Shipping address country ISO code |
| Invalid Shipping address state province abbreviation |
| Invalid shipping method |
| Only freight account is allowed for shipping method. |
| Invalid payment method |
| one order item is required |
| Invalid Product |
| Invalid Product quantity |
