@whiplashmerch/whiplash-api-client 2.0.7 → 2.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -98,7 +98,7 @@ export interface ApiV2EntitiesConsumerReturn {
98
98
  * @format date-time
99
99
  */
100
100
  created_at?: string;
101
- customer?: ApiV21EntitiesCustomer;
101
+ customer?: ApiV2EntitiesCustomerShallow;
102
102
  /**
103
103
  * the consumer return customer id
104
104
  * @format int32
@@ -187,7 +187,7 @@ export interface ApiV2EntitiesConsumerReturn {
187
187
  * @format date-time
188
188
  */
189
189
  updated_at?: string;
190
- warehouse?: ApiV21EntitiesWarehouse;
190
+ warehouse?: ApiV2EntitiesWarehouseShallow;
191
191
  /**
192
192
  * the consumer return warehouse id
193
193
  * @format int32
@@ -464,6 +464,223 @@ export interface ApiV2EntitiesCustomer {
464
464
  whitelisted_warehouses?: ApiV2EntitiesWarehouse;
465
465
  }
466
466
 
467
+ export interface ApiV2EntitiesCustomerShallow {
468
+ /** Customer billing address line 1. */
469
+ billing_address1?: string;
470
+ /** Customer billing address line 2. */
471
+ billing_address2?: string;
472
+ /** Customer billing address line 3. */
473
+ billing_address3?: string;
474
+ /** Customer phone 1. */
475
+ billing_phone1?: string;
476
+ /** Customer phone 2. */
477
+ billing_phone2?: string;
478
+ /** GS1 company prefix for barcodes */
479
+ gs1_company_prefix?: string;
480
+ /** Customer return address line 1. */
481
+ return_address_1?: string;
482
+ /** Customer return address line 2. */
483
+ return_address_2?: string;
484
+ /**
485
+ * Account level
486
+ * @format int32
487
+ */
488
+ account_level?: number;
489
+ /** Quote, Direct, Enterprise, or Managed */
490
+ account_level_name?: string;
491
+ /**
492
+ * the customer activation date and time
493
+ * @format date-time
494
+ */
495
+ activated_at?: string;
496
+ /** Customer active? */
497
+ active?: boolean;
498
+ /** Allow "b stock" role for receiving */
499
+ allow_b_stock_receiving?: boolean;
500
+ allowed_warehouse_ids?: number[];
501
+ /**
502
+ * Customer auto merge gestation.
503
+ * @format int32
504
+ */
505
+ auto_merge_gestation?: number;
506
+ /** auto merge SKUs? */
507
+ auto_merge_skus?: boolean;
508
+ /** Customer billing city. */
509
+ billing_city?: string;
510
+ /** Customer billing company. */
511
+ billing_company?: string;
512
+ /** Customer billing contact name. */
513
+ billing_contact_name?: string;
514
+ /** if false, disables hardcoded billing logic (staff only) */
515
+ billing_core?: boolean;
516
+ /** Customer billing country. */
517
+ billing_country?: string;
518
+ /** Customer billing email. */
519
+ billing_email?: string;
520
+ /** Customer billing residential? */
521
+ billing_residential?: boolean;
522
+ /** Customer billing state. */
523
+ billing_state?: string;
524
+ /** Customer billing zip. */
525
+ billing_zip?: string;
526
+ /**
527
+ * the customer creation date and time
528
+ * @format date-time
529
+ */
530
+ created_at?: string;
531
+ /** Data mapping string for this customer. (admins only) */
532
+ data_mapping_string?: string;
533
+ /**
534
+ * the customer deactivation date and time
535
+ * @format date-time
536
+ */
537
+ deactivated_at?: string;
538
+ /**
539
+ * Customer default warehouse id.
540
+ * @format int32
541
+ */
542
+ default_warehouse_id?: number;
543
+ /** Customer EIN / Tax ID */
544
+ ein?: string;
545
+ /** Customer email confirmation from. */
546
+ email_confirmation_from?: string;
547
+ /** Customer email confirmation name. */
548
+ email_confirmation_name?: string;
549
+ /** Customer EORI number. */
550
+ eori_number?: string;
551
+ /** Customer estimated monthly volume. */
552
+ estimated_monthly_volume?: string;
553
+ /** is this account flagged for exit notice? (admins only) */
554
+ exit_notice?: boolean;
555
+ /**
556
+ * items that are this many days from expiration will not be allowed to ship
557
+ * @format int32
558
+ */
559
+ expiration_period?: number;
560
+ /** Customer from email. */
561
+ from_email?: string;
562
+ /** Customer full logo url. */
563
+ full_logo_url?: string;
564
+ /**
565
+ * the customer id
566
+ * @format int32
567
+ */
568
+ id?: number;
569
+ /** Customer instructions. */
570
+ instructions?: string;
571
+ /** Customer has item scanning preference? */
572
+ item_scanning_preference?: boolean;
573
+ /** items exchangeable by default? */
574
+ items_exchangeable?: boolean;
575
+ /** items returnable by default? */
576
+ items_returnable?: boolean;
577
+ /**
578
+ * Process Orders setting: Whiplash will automatically turn on Process Orders when an item is received, and turn it off when an item sells. Whiplash will not manage Process Orders. Whiplash will automatically turn on Process Orders only the first time an Item is received. Whiplash will automatically turn on Process Orders when an item is received or adjusted in, and turn it off when an Item sells out.
579
+ * @format int32
580
+ */
581
+ items_unavailable_on_sellout?: number;
582
+ /** do items for this customer require lot control? */
583
+ lot_control?: boolean;
584
+ /**
585
+ * Quantity where an item in inventory would be considered having low inventory
586
+ * @format int32
587
+ */
588
+ low_inventory_threshold?: number;
589
+ /** Customer name. */
590
+ name?: string;
591
+ /** Customer notes. */
592
+ notes?: string;
593
+ /** notify originator? */
594
+ notify_originator?: boolean;
595
+ /**
596
+ * Customer notify originator inventory.
597
+ * @format int32
598
+ */
599
+ notify_originator_inventory?: number;
600
+ /** originator permissions? */
601
+ originator_permissions?: boolean;
602
+ /**
603
+ * Customer partner id. (admins only)
604
+ * @format int32
605
+ */
606
+ partner_id?: number;
607
+ /** is this account on hold pending a valid payment method? */
608
+ payment_hold?: boolean;
609
+ /** The Customers designated primary contact. */
610
+ primary_contact?: string;
611
+ project_task_labels?: string[];
612
+ receiving_fields?: object[];
613
+ /**
614
+ * Minimum number of days worth of stock to keep in forward pick locations
615
+ * @format float
616
+ */
617
+ replenishment_min?: number;
618
+ /**
619
+ * Target number of days stock to replenish forward pick locations
620
+ * @format float
621
+ */
622
+ replenishment_target?: number;
623
+ /** request serial numbers? */
624
+ request_serial_numbers?: boolean;
625
+ /** Customer return city. */
626
+ return_city?: string;
627
+ /** Customer return company. */
628
+ return_company?: string;
629
+ /** Customer return country. */
630
+ return_country?: string;
631
+ /** Customer return email. */
632
+ return_email?: string;
633
+ /**
634
+ * Return label expiration time limit.
635
+ * @format int32
636
+ */
637
+ return_label_expires_in?: number;
638
+ /** Customer return name. */
639
+ return_name?: string;
640
+ /** Customer return phone. */
641
+ return_phone?: string;
642
+ /** limit exchange to same value or less? */
643
+ return_price_restricted?: boolean;
644
+ /** Exchange SKU match policy. */
645
+ return_sku_match?: string;
646
+ /** Customer return state. */
647
+ return_state?: string;
648
+ /**
649
+ * Return time limit.
650
+ * @format int32
651
+ */
652
+ return_time_limit?: number;
653
+ /** Customer return zip. */
654
+ return_zip?: string;
655
+ /** display customer logo on returns page? */
656
+ rma_display_logo?: boolean;
657
+ /** Return page footer content. */
658
+ rma_footer_content?: string;
659
+ /**
660
+ * Customer shipping method preference.
661
+ * @format int32
662
+ */
663
+ ship_method_preference?: number;
664
+ /**
665
+ * which locations to pick first: Default, FIFO, FEFO
666
+ * @format int32
667
+ */
668
+ ship_strategy?: number;
669
+ /** Customer shipping name. */
670
+ shipping_name?: string;
671
+ /** does the customer support return labels? */
672
+ supports_return_labels?: boolean;
673
+ /** Customer VAT number. */
674
+ vat_number?: string;
675
+ /**
676
+ * Customer warehouse fallback.
677
+ * @format int32
678
+ */
679
+ warehouse_fallback?: number;
680
+ /** Workday UUID */
681
+ workday_uuid?: string;
682
+ }
683
+
467
684
  export interface ApiV2EntitiesCustomsInfo {
468
685
  /** AU VAT number */
469
686
  au_vat_number?: string;
@@ -1660,8 +1877,18 @@ export interface ApiV2EntitiesPackage {
1660
1877
  */
1661
1878
  order_id?: number;
1662
1879
  order_item_ids?: number[];
1880
+ /**
1881
+ * the pallet id this package is on (staff only)
1882
+ * @format int32
1883
+ */
1884
+ pallet_id?: number;
1663
1885
  /** the package scan form url (staff only) */
1664
1886
  scan_form_url?: string;
1887
+ /**
1888
+ * when the package was scanned to a pallet (staff only)
1889
+ * @format date-time
1890
+ */
1891
+ scanned_to_pallet_at?: string;
1665
1892
  /**
1666
1893
  * the package shipping cost
1667
1894
  * @format float
@@ -2485,6 +2712,139 @@ export interface ApiV2EntitiesWarehouse {
2485
2712
  warehouse_features?: string;
2486
2713
  }
2487
2714
 
2715
+ export interface ApiV2EntitiesWarehouseShallow {
2716
+ /** Warehouse address line 1 */
2717
+ shipping_address_1?: string;
2718
+ /** Warehouse address line 2 */
2719
+ shipping_address_2?: string;
2720
+ /** Warehouse country code */
2721
+ shipping_country_iso2?: string;
2722
+ /** Is this Warehouse accepting new customers? (partners only) */
2723
+ accepting_new_customers?: boolean;
2724
+ /** Is the Warehouse active? (partners only) */
2725
+ active?: boolean;
2726
+ /**
2727
+ * Maximum cubic volume per bin (staff only)
2728
+ * @format float
2729
+ */
2730
+ bin_cubic_volume_max?: number;
2731
+ /**
2732
+ * Maximum total items per bin (staff only)
2733
+ * @format int32
2734
+ */
2735
+ bin_total_count_max?: number;
2736
+ /** Warehouse contact name (partners only) */
2737
+ contact_name?: string;
2738
+ /** Warehouse contact phone (partners only) */
2739
+ contact_phone?: string;
2740
+ /**
2741
+ * the warehouse creation date and time (partners only)
2742
+ * @format date-time
2743
+ */
2744
+ created_at?: string;
2745
+ /** Warehouse currency (partners only) */
2746
+ currency?: string;
2747
+ /** Paper or Robot scanning by default when batching? (staff only) */
2748
+ default_pick_strategy?: string;
2749
+ /** Does this Warehouse have delivery appointment reminders? (partners only) */
2750
+ delivery_appointment_required?: boolean;
2751
+ /** Warehouse does domestic return labels? (partners only) */
2752
+ domestic_return_labels?: boolean;
2753
+ /** the warehouse email address (partners only) */
2754
+ email?: string;
2755
+ /** Fulfillment cost center */
2756
+ fulfillment_cost_center?: string;
2757
+ /**
2758
+ * the warehouse id
2759
+ * @format int32
2760
+ */
2761
+ id?: number;
2762
+ /** Warehouse does intl return labels? (partners only) */
2763
+ international_return_labels?: boolean;
2764
+ /** Warehouse label format (partners only) */
2765
+ label_format?: string;
2766
+ /**
2767
+ * Warehouse latitude
2768
+ * @format float
2769
+ */
2770
+ latitude?: number;
2771
+ /**
2772
+ * Loading Dock Quantity (partners only)
2773
+ * @format int32
2774
+ */
2775
+ loading_dock_quantity?: number;
2776
+ /**
2777
+ * Warehouse longitude
2778
+ * @format float
2779
+ */
2780
+ longitude?: number;
2781
+ /** the warehouse name */
2782
+ name?: string;
2783
+ /** Miscellaneous notes/info (partners only) */
2784
+ notes?: string;
2785
+ /**
2786
+ * Number of slots/bins in carts--default maximum number of orders in a batch (staff only)
2787
+ * @format int32
2788
+ */
2789
+ number_of_groups?: number;
2790
+ /**
2791
+ * Packaging Customer ID (partners only)
2792
+ * @format int32
2793
+ */
2794
+ packaging_customer_id?: number;
2795
+ /** Parcel cost center */
2796
+ parcel_cost_center?: string;
2797
+ /**
2798
+ * Warehouse partner id
2799
+ * @format int32
2800
+ */
2801
+ partner_id?: number;
2802
+ /** Warehouse pickup hours (partners only) */
2803
+ pickup_hours?: string;
2804
+ /** Warehouse receiving hours (partners only) */
2805
+ receiving_hours?: string;
2806
+ /** Receiving special instructions (partners only) */
2807
+ receiving_special_instructions?: string;
2808
+ /** Warehouse city */
2809
+ shipping_city?: string;
2810
+ /** Warehouse country */
2811
+ shipping_country?: string;
2812
+ /** Warehouse shipping label format - EPL2 or ZPL (partners only) */
2813
+ shipping_label_format?: string;
2814
+ /** Warehouse state or province */
2815
+ shipping_state?: string;
2816
+ /** Warehouse postal code */
2817
+ shipping_zip?: string;
2818
+ /** Single Item Batch Size (partners only) */
2819
+ single_item_batch_size?: string;
2820
+ /** Warehouse slug */
2821
+ slug?: string;
2822
+ /**
2823
+ * Warehouse square footage (partners only)
2824
+ * @format int32
2825
+ */
2826
+ square_footage?: number;
2827
+ /** Warehouse timezone in friendly/legacy format (eg. "Eastern Time (US & Canada)") */
2828
+ timezone?: string;
2829
+ /** Warehouse timezone in standard format (eg. "America/New_York") */
2830
+ timezone_raw?: string;
2831
+ /**
2832
+ * the warehouse last update date and time (partners only)
2833
+ * @format date-time
2834
+ */
2835
+ updated_at?: string;
2836
+ /** Warehouse carrier facility (partners only) */
2837
+ ups_carrier_facility?: string;
2838
+ /** Warehouse UPS shipping number (partners only) */
2839
+ ups_shipper_number?: string;
2840
+ /**
2841
+ * Warehouse VAT number (partners only)
2842
+ * @format float
2843
+ */
2844
+ vat?: number;
2845
+ warehouse_features?: string;
2846
+ }
2847
+
2488
2848
  export interface ApiV2EntitiesWholesale {
2489
2849
  /**
2490
2850
  * the latest possible arrival time for the shipment
@@ -3998,139 +4358,6 @@ export interface ApiV21EntitiesTemplate {
3998
4358
  url?: string;
3999
4359
  }
4000
4360
 
4001
- export interface ApiV21EntitiesWarehouse {
4002
- /** Warehouse address line 1 */
4003
- shipping_address_1?: string;
4004
- /** Warehouse address line 2 */
4005
- shipping_address_2?: string;
4006
- /** Warehouse country code */
4007
- shipping_country_iso2?: string;
4008
- /** Is this Warehouse accepting new customers? (partners only) */
4009
- accepting_new_customers?: boolean;
4010
- /** Is the Warehouse active? (partners only) */
4011
- active?: boolean;
4012
- /**
4013
- * Maximum cubic volume per bin (staff only)
4014
- * @format float
4015
- */
4016
- bin_cubic_volume_max?: number;
4017
- /**
4018
- * Maximum total items per bin (staff only)
4019
- * @format int32
4020
- */
4021
- bin_total_count_max?: number;
4022
- /** Warehouse contact name (partners only) */
4023
- contact_name?: string;
4024
- /** Warehouse contact phone (partners only) */
4025
- contact_phone?: string;
4026
- /**
4027
- * the warehouse creation date and time (partners only)
4028
- * @format date-time
4029
- */
4030
- created_at?: string;
4031
- /** Warehouse currency (partners only) */
4032
- currency?: string;
4033
- /** Paper or Robot scanning by default when batching? (staff only) */
4034
- default_pick_strategy?: string;
4035
- /** Does this Warehouse have delivery appointment reminders? (partners only) */
4036
- delivery_appointment_required?: boolean;
4037
- /** Warehouse does domestic return labels? (partners only) */
4038
- domestic_return_labels?: boolean;
4039
- /** the warehouse email address (partners only) */
4040
- email?: string;
4041
- /** Fulfillment cost center */
4042
- fulfillment_cost_center?: string;
4043
- /**
4044
- * the warehouse id
4045
- * @format int32
4046
- */
4047
- id?: number;
4048
- /** Warehouse does intl return labels? (partners only) */
4049
- international_return_labels?: boolean;
4050
- /** Warehouse label format (partners only) */
4051
- label_format?: string;
4052
- /**
4053
- * Warehouse latitude
4054
- * @format float
4055
- */
4056
- latitude?: number;
4057
- /**
4058
- * Loading Dock Quantity (partners only)
4059
- * @format int32
4060
- */
4061
- loading_dock_quantity?: number;
4062
- /**
4063
- * Warehouse longitude
4064
- * @format float
4065
- */
4066
- longitude?: number;
4067
- /** the warehouse name */
4068
- name?: string;
4069
- /** Miscellaneous notes/info (partners only) */
4070
- notes?: string;
4071
- /**
4072
- * Number of slots/bins in carts--default maximum number of orders in a batch (staff only)
4073
- * @format int32
4074
- */
4075
- number_of_groups?: number;
4076
- /**
4077
- * Packaging Customer ID (partners only)
4078
- * @format int32
4079
- */
4080
- packaging_customer_id?: number;
4081
- /** Parcel cost center */
4082
- parcel_cost_center?: string;
4083
- /**
4084
- * Warehouse partner id
4085
- * @format int32
4086
- */
4087
- partner_id?: number;
4088
- /** Warehouse pickup hours (partners only) */
4089
- pickup_hours?: string;
4090
- /** Warehouse receiving hours (partners only) */
4091
- receiving_hours?: string;
4092
- /** Receiving special instructions (partners only) */
4093
- receiving_special_instructions?: string;
4094
- /** Warehouse city */
4095
- shipping_city?: string;
4096
- /** Warehouse country */
4097
- shipping_country?: string;
4098
- /** Warehouse shipping label format - EPL2 or ZPL (partners only) */
4099
- shipping_label_format?: string;
4100
- /** Warehouse state or province */
4101
- shipping_state?: string;
4102
- /** Warehouse postal code */
4103
- shipping_zip?: string;
4104
- /** Single Item Batch Size (partners only) */
4105
- single_item_batch_size?: string;
4106
- /** Warehouse slug */
4107
- slug?: string;
4108
- /**
4109
- * Warehouse square footage (partners only)
4110
- * @format int32
4111
- */
4112
- square_footage?: number;
4113
- /** Warehouse timezone in friendly/legacy format (eg. "Eastern Time (US & Canada)") */
4114
- timezone?: string;
4115
- /** Warehouse timezone in standard format (eg. "America/New_York") */
4116
- timezone_raw?: string;
4117
- /**
4118
- * the warehouse last update date and time (partners only)
4119
- * @format date-time
4120
- */
4121
- updated_at?: string;
4122
- /** Warehouse carrier facility (partners only) */
4123
- ups_carrier_facility?: string;
4124
- /** Warehouse UPS shipping number (partners only) */
4125
- ups_shipper_number?: string;
4126
- /**
4127
- * Warehouse VAT number (partners only)
4128
- * @format float
4129
- */
4130
- vat?: number;
4131
- warehouse_features?: string;
4132
- }
4133
-
4134
4361
  export interface ApiV21EntitiesWholesale {
4135
4362
  /**
4136
4363
  * the latest possible arrival time for the shipment
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@whiplashmerch/whiplash-api-client",
3
- "version": "2.0.7",
3
+ "version": "2.0.9",
4
4
  "description": "",
5
5
  "devDependencies": {},
6
6
  "scripts": {